Class CmsSubmenu
- java.lang.Object
-
- org.opencms.ui.contextmenu.CmsSubmenu
-
- All Implemented Interfaces:
I_CmsContextMenuAction
,I_CmsContextMenuItem
,I_CmsHasMenuItemVisibility
public class CmsSubmenu extends java.lang.Object implements I_CmsContextMenuItem
Menu item which acts only as a container for nested menu items.
-
-
Field Summary
Fields Modifier and Type Field Description protected java.lang.String
m_id
The item id.protected float
m_order
The order.protected java.lang.String
m_parentId
The parent item id.protected int
m_priority
The priority.
-
Constructor Summary
Constructors Constructor Description CmsSubmenu(java.lang.String id, java.lang.String parentId, java.lang.String title, float order, int priority)
Creates a new instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
executeAction(I_CmsDialogContext context)
Executes the context menu action given a dialog context.java.lang.String
getId()
Gets the id.float
getOrder()
Integer attribute which is used to order menu items.java.lang.String
getParentId()
Gets the id of the parent entry.int
getPriority()
Gets the priority.java.lang.String
getTitle(java.util.Locale locale)
Gets the title.CmsMenuItemVisibilityMode
getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
Computes the visibility for this context menu items with the given CMS context and resources.CmsMenuItemVisibilityMode
getVisibility(I_CmsDialogContext context)
Gets the visibility for the current dialog context.boolean
isLeafItem()
Returns true if this is a leaf item, i.e.
-
-
-
Field Detail
-
m_id
protected java.lang.String m_id
The item id.
-
m_parentId
protected java.lang.String m_parentId
The parent item id.
-
m_order
protected float m_order
The order.
-
m_priority
protected int m_priority
The priority.
-
-
Constructor Detail
-
CmsSubmenu
public CmsSubmenu(java.lang.String id, java.lang.String parentId, java.lang.String title, float order, int priority)
Creates a new instance.- Parameters:
id
- the idparentId
- the parent idtitle
- the titleorder
- the orderpriority
- the priority
-
-
Method Detail
-
executeAction
public void executeAction(I_CmsDialogContext context)
Description copied from interface:I_CmsContextMenuItem
Executes the context menu action given a dialog context.- Specified by:
executeAction
in interfaceI_CmsContextMenuAction
- Specified by:
executeAction
in interfaceI_CmsContextMenuItem
- Parameters:
context
- the dialog context- See Also:
I_CmsContextMenuItem.executeAction(org.opencms.ui.I_CmsDialogContext)
-
getId
public java.lang.String getId()
Description copied from interface:I_CmsContextMenuItem
Gets the id.The id does not need to be unique among all context menu items which are in use in the system, but when multiple menu items with the same id are available for a given context menu, only one of them will be picked, based on the priority (a higher priority context menu item will be preferred to one with a lower priority.
- Specified by:
getId
in interfaceI_CmsContextMenuItem
- Returns:
- the id
- See Also:
I_CmsContextMenuItem.getId()
-
getOrder
public float getOrder()
Description copied from interface:I_CmsContextMenuItem
Integer attribute which is used to order menu items.Items with a higher 'order' value will appear after items with a lower order at the same tree level.
- Specified by:
getOrder
in interfaceI_CmsContextMenuItem
- Returns:
- the order
- See Also:
I_CmsContextMenuItem.getOrder()
-
getParentId
public java.lang.String getParentId()
Description copied from interface:I_CmsContextMenuItem
Gets the id of the parent entry.If this returns null, the context menu item will be inserted at the root level of the context menu, otherwise, it will be added I_CmsContextMenuActionas a sub-entry of the context menu entry with the given id (if such an entry exists; otherwise, the child entry will be ignored).
- Specified by:
getParentId
in interfaceI_CmsContextMenuItem
- Returns:
- the parent id
- See Also:
I_CmsContextMenuItem.getParentId()
-
getPriority
public int getPriority()
Description copied from interface:I_CmsContextMenuItem
Gets the priority.If multiple context menu items with the same id are available for a menu, the one with the highest priority will be picked.
- Specified by:
getPriority
in interfaceI_CmsContextMenuItem
- Returns:
- the priority
- See Also:
I_CmsContextMenuItem.getPriority()
-
getTitle
public java.lang.String getTitle(java.util.Locale locale)
Description copied from interface:I_CmsContextMenuItem
Gets the title.- Specified by:
getTitle
in interfaceI_CmsContextMenuItem
- Parameters:
locale
- the locale- Returns:
- the title
- See Also:
I_CmsContextMenuItem.getTitle(java.util.Locale)
-
getVisibility
public CmsMenuItemVisibilityMode getVisibility(CmsObject cms, java.util.List<CmsResource> resources)
Description copied from interface:I_CmsContextMenuItem
Computes the visibility for this context menu items with the given CMS context and resources.- Specified by:
getVisibility
in interfaceI_CmsContextMenuItem
- Specified by:
getVisibility
in interfaceI_CmsHasMenuItemVisibility
- Parameters:
cms
- the current CMS contextresources
- the resources for which the context menu is being opened- Returns:
- the visibility of the context menu item
- See Also:
I_CmsContextMenuItem.getVisibility(org.opencms.file.CmsObject, java.util.List)
-
getVisibility
public CmsMenuItemVisibilityMode getVisibility(I_CmsDialogContext context)
Description copied from interface:I_CmsHasMenuItemVisibility
Gets the visibility for the current dialog context.- Specified by:
getVisibility
in interfaceI_CmsHasMenuItemVisibility
- Parameters:
context
- the dialog context- Returns:
- the visibility
- See Also:
I_CmsHasMenuItemVisibility.getVisibility(org.opencms.ui.I_CmsDialogContext)
-
isLeafItem
public boolean isLeafItem()
Description copied from interface:I_CmsContextMenuItem
Returns true if this is a leaf item, i.e. an item which has no child items.- Specified by:
isLeafItem
in interfaceI_CmsContextMenuItem
- Returns:
- true if this is a leaf item
- See Also:
I_CmsContextMenuItem.isLeafItem()
-
-