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