Package org.opencms.acacia.client
Class CmsChoiceMenuEntryBean
java.lang.Object
org.opencms.acacia.client.CmsChoiceMenuEntryBean
A bean which contains the data for a choice menu entry.
-
Field Summary
Modifier and TypeFieldDescriptionprotected List<CmsChoiceMenuEntryBean>
The child entries of this choice.protected CmsChoiceMenuEntryBean
The parent of this entry.protected String
The path component (attribute id) of this menu entry. -
Constructor Summary
ConstructorDescriptionCmsChoiceMenuEntryBean
(String pathComponent) Creates a new choice menu entry bean. -
Method Summary
Modifier and TypeMethodDescriptionAdds a new child entry to this bean and returns it.Gets the list of children of this entry.getHelp
(I_CmsWidgetService widgetService) Gets the help text for the menu entry.getLabel
(I_CmsWidgetService widgetService) Gets the label for the menu entry.Gets the parent entry of this entry.getPath()
Gets the complete path of this entry, which is a list of attribute ids.Gets the path component of this entry.boolean
isLeaf()
Returns true if this entry has no children.
-
Field Details
-
m_children
The child entries of this choice. -
m_parent
The parent of this entry. -
m_pathComponent
The path component (attribute id) of this menu entry.
-
-
Constructor Details
-
CmsChoiceMenuEntryBean
Creates a new choice menu entry bean.- Parameters:
pathComponent
- the path component of the choice (attribute id)
-
-
Method Details
-
addChild
Adds a new child entry to this bean and returns it.- Parameters:
pathComponent
- the path component of the child- Returns:
- the new child
-
getChildren
Gets the list of children of this entry.- Returns:
- the list of children
-
getHelp
Gets the help text for the menu entry.- Parameters:
widgetService
- the widget service to ask for labels- Returns:
- the help text
-
getLabel
Gets the label for the menu entry.- Parameters:
widgetService
- the widget service to ask for label texts- Returns:
- the entry label
-
getParent
Gets the parent entry of this entry.- Returns:
- the parent entry
-
getPath
Gets the complete path of this entry, which is a list of attribute ids.- Returns:
- the path of this entry
-
getPathComponent
Gets the path component of this entry.- Returns:
- the path component
-
isLeaf
Returns true if this entry has no children.- Returns:
- true if this entry has no children
-