org.efaps.ui.wicket.models.objects
Class AbstractUIPageObject

java.lang.Object
  org.efaps.ui.wicket.models.AbstractInstanceObject
      org.efaps.ui.wicket.models.objects.AbstractUIObject
          org.efaps.ui.wicket.models.objects.AbstractUIPageObject

All Implemented Interfaces:

Serializable, org.apache.wicket.IClusterable

Direct Known Subclasses:

UIForm, UIStructurBrowser, UITable

public abstract class AbstractUIPageObject
extends AbstractUIObject

TODO comment!

Version:

$Id: AbstractUIPageObject.java 5758 2010-10-27 21:22:43Z jan.moxter $

Author:

The eFaps Team

See Also:

Serialized Form

Constructor Summary

AbstractUIPageObject(org.apache.wicket.PageParameters _parameters)
Constructor evaluating the UUID for the command and the oid from an Opener instance.

AbstractUIPageObject(UUID _commandUUID, String _instanceKey)
Constructor.

AbstractUIPageObject(UUID _commandUUID, String _instanceKey, String _openerId)
Constructor.

Method Summary

void	addHidden(UIHiddenCell _hiddenCell) Method to add a hidden Cell to the list hiddenCells.
protected Map<org.efaps.db.Instance,Boolean>	checkAccessToInstances(List<org.efaps.db.Instance> _instances) Used to check the access to e.g.
Map<org.efaps.db.Instance,Boolean>	getAccessMap() Getter method for the instance variable accessMap.
String	getHelpTarget() Getter method for instance variable helpTarget.
List<UIHiddenCell>	getHiddenCells() Getter method for instance variable hiddenCells.
String	getNewRandom()
org.efaps.admin.ui.AbstractCommand	getTargetCmd() Get the CommandAbstract that is the target of this Page.
UUID	getTargetCmdUUID() Getter method for instance variable targetCmdUUID.
Map<String,String>	getUiID2Oid() Getter method for the instance variable uiID2Oid.
protected Object	getValue4Wizard(String _key) Method to get the value for a key in case of wizard.
UIWizardObject	getWizard() Getter method for instance variable wizard.
boolean	hasTargetCmd() Method returns if this pageobject has a target command.
boolean	isPartOfWizardCall() Getter method for instance variable partOfWizardCall.
boolean	isRenderRevise() Getter method for instance variable renderRevise.
boolean	isTargetCmdRevise() Getter method for instance variable targetCmdRevise.
boolean	isTargetShowFile() Getter method for instance variable isTargetShowFile.
void	setPartOfWizardCall(boolean _wizardCall) Setter method for instance variable partOfWizardCall.
void	setRenderRevise(boolean _renderRevise) Setter method for instance variable renderRevise.
void	setTargetCmdRevise(boolean _targetCmdRevise) Setter method for instance variable targetCmdRevise.
void	setTargetCmdUUID(UUID _targetCmdUUID) Setter method for instance variable targetCmdUUID.
void	setWizard(UIWizardObject _wizard) Setter method for instance variable wizard.

Methods inherited from class org.efaps.ui.wicket.models.objects.AbstractUIObject

addEventObject, execute, executeEvents, getCallingCommand, getCallingCommandUUID, getCommand, getCommand, getCommandUUID, getInstanceFromManager, getMenuTreeKey, getMode, getOpenerId, getTarget, getTitle, hasInstanceManager, isCreateMode, isEditMode, isInitialized, isPicker, isPrintMode, isSearchMode, isSubmit, isViewMode, resetModel, setCallingCommandUUID, setCommandUUID, setInitialized, setMode, setOpenerId, setSubmit, validate

Methods inherited from class org.efaps.ui.wicket.models.AbstractInstanceObject

getInstance, getInstanceKey, setInstanceKey

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractUIPageObject

public AbstractUIPageObject(org.apache.wicket.PageParameters _parameters)

Constructor evaluating the UUID for the command and the oid from an Opener instance.

Parameters:

_parameters - PageParameters for this Model

AbstractUIPageObject

public AbstractUIPageObject(UUID _commandUUID,
                            String _instanceKey,
                            String _openerId)

Constructor.

Parameters:

_commandUUID - UUID for this Model

_instanceKey - instance id for this Model

_openerId - id of the opener

AbstractUIPageObject

public AbstractUIPageObject(UUID _commandUUID,
                            String _instanceKey)

Constructor.

Parameters:

_commandUUID - UUID for this Model

_instanceKey - instance id for this Model

Method Detail

getHiddenCells

public List<UIHiddenCell> getHiddenCells()

Getter method for instance variable hiddenCells.

Returns:

value of instance variable hiddenCells

addHidden

public void addHidden(UIHiddenCell _hiddenCell)

Method to add a hidden Cell to the list hiddenCells.

Parameters:

_hiddenCell - cell to add

getTargetCmd

public org.efaps.admin.ui.AbstractCommand getTargetCmd()

Get the CommandAbstract that is the target of this Page.

Returns:

the calling CommandAbstract

See Also:

targetCmdUUID

getTargetCmdUUID

public UUID getTargetCmdUUID()

Getter method for instance variable targetCmdUUID.

Returns:

value of instance variable targetCmdUUID

setTargetCmdUUID

public void setTargetCmdUUID(UUID _targetCmdUUID)

Setter method for instance variable targetCmdUUID.

Parameters:

_targetCmdUUID - value for instance variable targetCmdUUID

hasTargetCmd

public boolean hasTargetCmd()

Method returns if this pageobject has a target command.

Returns:

true if targetCmdUUID !=null

isTargetCmdRevise

public boolean isTargetCmdRevise()

Getter method for instance variable targetCmdRevise.

Returns:

value of instance variable targetCmdRevise

isTargetShowFile

public boolean isTargetShowFile()

Getter method for instance variable isTargetShowFile.

Returns:

value of instance variable isTargetShowFile

setTargetCmdRevise

public void setTargetCmdRevise(boolean _targetCmdRevise)

Setter method for instance variable targetCmdRevise.

Parameters:

_targetCmdRevise - value for instance variable targetCmdRevise

getWizard

public UIWizardObject getWizard()

Getter method for instance variable wizard.

Returns:

value of instance variable wizard

setWizard

public void setWizard(UIWizardObject _wizard)

Setter method for instance variable wizard.

Parameters:

_wizard - value for instance variable wizard

setPartOfWizardCall

public void setPartOfWizardCall(boolean _wizardCall)

Setter method for instance variable partOfWizardCall.

Parameters:

_wizardCall - value for instance variable partOfWizardCall

isPartOfWizardCall

public boolean isPartOfWizardCall()

Getter method for instance variable partOfWizardCall.

Returns:

value of instance variable partOfWizardCall

getValue4Wizard

protected Object getValue4Wizard(String _key)

Method to get the value for a key in case of wizard.

Parameters:

_key - key for the value

Returns:

value for the object, if found, else null

isRenderRevise

public boolean isRenderRevise()

Getter method for instance variable renderRevise.

Returns:

value of instance variable renderRevise

setRenderRevise

public void setRenderRevise(boolean _renderRevise)

Setter method for instance variable renderRevise.

Parameters:

_renderRevise - value for instance variable renderRevise

getHelpTarget

public String getHelpTarget()

Getter method for instance variable helpTarget.

Returns:

value of instance variable helpTarget

getUiID2Oid

public Map<String,String> getUiID2Oid()

Getter method for the instance variable uiID2Oid.

Returns:

value of instance variable uiID2Oid

getNewRandom

public String getNewRandom()

Returns:

a new for this instance unique random key.

checkAccessToInstances

protected Map<org.efaps.db.Instance,Boolean> checkAccessToInstances(List<org.efaps.db.Instance> _instances)
                                                             throws org.efaps.util.EFapsException

Used to check the access to e.g. TreeMenus.

Parameters:

_instances - Instances that must be checked for access

Returns:

Map with Instance to Boolean

Throws:

org.efaps.util.EFapsException - on error

getAccessMap

public Map<org.efaps.db.Instance,Boolean> getAccessMap()

Getter method for the instance variable accessMap.

Returns:

value of instance variable accessMap