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

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

All Implemented Interfaces:

Serializable, org.apache.wicket.IClusterable, ICmdUIObject

Direct Known Subclasses:

UISearchItem

public class UIMenuItem
extends AbstractUIObject
implements ICmdUIObject

This class provides the Model for rendering MenuComponents in #org.efaps.ui.wicket.components.menu.MenuPanel and in #org.efaps.ui.wicket.components.menutree.MenuTree.

Version:

$Id: UIMenuItem.java 5888 2010-12-01 02:44:58Z jan@moxter.net $

Author:

The eFaps Team

See Also:

Serialized Form

Constructor Summary

UIMenuItem(UUID _uuid)
Constructor setting the UUID of this MenuItem.

UIMenuItem(UUID _uuid, String _instanceKey)
Constructor setting the UUID and the key for the instance of this MenuItem.

Method Summary

void	execute() Method is used to execute the UIObject (Fill it with data).
DefaultMutableTreeNode	getAncestor() This is the getter method for the instance variable ancestor.
List<UIMenuItem>	getChilds() This is the getter method for the instance variable childs.
String	getDescription() This is the getter method for the instance variable description.
String	getImage() This is the getter method for the instance variable image.
String	getLabel() This is the getter method for the instance variable label.
DefaultMutableTreeNode	getNode() get a Node of this MenuItemModel including the Childs.
String	getReference() This is the getter method for the instance variable reference.
int	getSubmitSelectedRows() Getter method for the instance variable submitSelectedRows.
TreeModel	getTreeModel() get a TreeModel which used in the Components to construct the actuall tree.
String	getTypeImage() This method returns the URL to the Image of this MenuItem.
String	getUrl() This is the getter method for the instance variable url.
int	getWindowHeight() This is the getter method for the instance variable windowHeight .
int	getWindowWidth() This is the getter method for the instance variable windowWidth.
boolean	hasChilds() this method returns, if this MenuItem has childs.
boolean	isAskUser() This is the getter method for the instance variable askUser.
boolean	isDefaultSelected() This is the getter method for the instance variable defaultSelected.
boolean	isHeader() This is the getter method for the instance variable header.
boolean	isStepInto() This is the getter method for the instance variable stepInto.
void	requeryLabel() Requery the Label.
void	resetModel() This Method resets the Model, so that the next time the Model is going to be connected, the underlying Data will be received newly from the eFapsDataBase.
void	setAncestor(DefaultMutableTreeNode _node) This is the setter method for the instance variable ancestor.
void	setHeader(boolean _header) This is the setter method for the instance variable header.
void	setStepInto(boolean _stepInto) This is the setter method for the instance variable stepInto.
void	setURL(String _url) This is the setter method for the instance variable url.

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

addEventObject, executeEvents, getCallingCommand, getCallingCommandUUID, getCommand, getCommand, getCommandUUID, getInstanceFromManager, getMenuTreeKey, getMode, getOpenerId, getTarget, getTitle, hasInstanceManager, isCreateMode, isEditMode, isInitialized, isPicker, isPrintMode, isSearchMode, isSubmit, isViewMode, 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

Methods inherited from interface org.efaps.ui.wicket.components.modalwindow.ICmdUIObject

getCommand, getInstanceKey

Constructor Detail

UIMenuItem

public UIMenuItem(UUID _uuid)

Constructor setting the UUID of this MenuItem.

Parameters:

_uuid - UUID

UIMenuItem

public UIMenuItem(UUID _uuid,
                  String _instanceKey)

Constructor setting the UUID and the key for the instance of this MenuItem.

Parameters:

_uuid - UUID

_instanceKey - instance Key

Method Detail

hasChilds

public boolean hasChilds()

this method returns, if this MenuItem has childs.

Returns:

true if this MenuItem has childs, else false

See Also:

childs, getChilds()

getChilds

public List<UIMenuItem> getChilds()

This is the getter method for the instance variable childs.

Returns:

value of instance variable childs

getDescription

public String getDescription()

This is the getter method for the instance variable description.

Returns:

value of instance variable description

getImage

public String getImage()

This is the getter method for the instance variable image.

Returns:

value of instance variable image

getLabel

public String getLabel()

This is the getter method for the instance variable label.

Returns:

value of instance variable label

getReference

public String getReference()

This is the getter method for the instance variable reference.

Returns:

value of instance variable reference

getSubmitSelectedRows

public int getSubmitSelectedRows()

Getter method for the instance variable submitSelectedRows.

Returns:

value of instance variable submitSelectedRows

getTypeImage

public String getTypeImage()
                    throws org.efaps.util.EFapsException

This method returns the URL to the Image of this MenuItem.

Returns:

URL of the Image

Throws:

org.efaps.util.EFapsException - on error

getUrl

public String getUrl()

This is the getter method for the instance variable url.

Returns:

value of instance variable url

setURL

public void setURL(String _url)

This is the setter method for the instance variable url.

Parameters:

_url - the url to set

getWindowHeight

public int getWindowHeight()

This is the getter method for the instance variable windowHeight .

Returns:

value of instance variable windowHeight

getWindowWidth

public int getWindowWidth()

This is the getter method for the instance variable windowWidth.

Returns:

value of instance variable windowWidth

requeryLabel

public void requeryLabel()

Requery the Label.

isAskUser

public boolean isAskUser()

This is the getter method for the instance variable askUser.

Returns:

value of instance variable askUser

isDefaultSelected

public boolean isDefaultSelected()

This is the getter method for the instance variable defaultSelected.

Returns:

value of instance variable defaultSelected

isHeader

public boolean isHeader()

This is the getter method for the instance variable header.

Returns:

value of instance variable header

setHeader

public void setHeader(boolean _header)

This is the setter method for the instance variable header.

Parameters:

_header - the header to set

isStepInto

public boolean isStepInto()

This is the getter method for the instance variable stepInto.

Returns:

value of instance variable stepInto

setStepInto

public void setStepInto(boolean _stepInto)

This is the setter method for the instance variable stepInto.

Parameters:

_stepInto - the stepInto to set

resetModel

public void resetModel()

This Method resets the Model, so that the next time the Model is going to be connected, the underlying Data will be received newly from the eFapsDataBase.

Specified by:

resetModel in class AbstractUIObject

getTreeModel

public TreeModel getTreeModel()

get a TreeModel which used in the Components to construct the actuall tree.

Returns:

TreeModel of this MenuItemModel including the ChildNodes

See Also:

getNode()

getNode

public DefaultMutableTreeNode getNode()

get a Node of this MenuItemModel including the Childs.

Returns:

DefaultMutableTreeNode of this MenuItemModel including the ChildNodes

See Also:

addNode(DefaultMutableTreeNode, List)

getAncestor

public DefaultMutableTreeNode getAncestor()

This is the getter method for the instance variable ancestor.

Returns:

value of instance variable ancestor

setAncestor

public void setAncestor(DefaultMutableTreeNode _node)

This is the setter method for the instance variable ancestor.

Parameters:

_node - the ancestor to set

execute

public void execute()

Description copied from class: AbstractUIObject

Method is used to execute the UIObject (Fill it with data).

Specified by:

execute in class AbstractUIObject

See Also:

AbstractUIObject.execute()