org.opencms.workplace.explorer.menu
Class CmsMenuItemVisibilityMode

java.lang.Object
  extended byorg.opencms.util.A_CmsModeIntEnumeration
      extended byorg.opencms.workplace.explorer.menu.CmsMenuItemVisibilityMode
All Implemented Interfaces:
java.io.Serializable

public final class CmsMenuItemVisibilityMode
extends A_CmsModeIntEnumeration

The visibility modes of a context menu item in the explorer view.

Since:
6.5.6
Version:
$Revision: 1.5 $
Author:
Andreas Zahner
See Also:
Serialized Form

Field Summary
static CmsMenuItemVisibilityMode VISIBILITY_ACTIVE
          Menu item visibility: active.
static CmsMenuItemVisibilityMode VISIBILITY_INACTIVE
          Menu item visibility: inactive.
static CmsMenuItemVisibilityMode VISIBILITY_INVISIBLE
          Menu item visibility: invisible.
 
Method Summary
 CmsMenuItemVisibilityMode addMessageKey(java.lang.String messageKey)
          Adds the name of the message key for the visibility mode.
protected  java.lang.Object clone()
           
 java.lang.String getMessageKey()
          Returns the name of the message key for the visibility mode.
 boolean isActive()
          Returns if the mode is set to VISIBILITY_ACTIVE.
 boolean isInActive()
          Returns if the mode is set to VISIBILITY_INACTIVE.
 boolean isInVisible()
          Returns if the mode is set to VISIBILITY_INVISIBLE.
static CmsMenuItemVisibilityMode valueOf(int type)
          Returns the menu item visibility mode for the given mode value.
 
Methods inherited from class org.opencms.util.A_CmsModeIntEnumeration
equals, getMode, hashCode, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

VISIBILITY_ACTIVE

public static final CmsMenuItemVisibilityMode VISIBILITY_ACTIVE
Menu item visibility: active.


VISIBILITY_INACTIVE

public static final CmsMenuItemVisibilityMode VISIBILITY_INACTIVE
Menu item visibility: inactive.


VISIBILITY_INVISIBLE

public static final CmsMenuItemVisibilityMode VISIBILITY_INVISIBLE
Menu item visibility: invisible.

Method Detail

valueOf

public static CmsMenuItemVisibilityMode valueOf(int type)
Returns the menu item visibility mode for the given mode value.

This is used only for serialization and should not be accessed for other purposes.

Parameters:
type - the mode value to get the item visibility mode for
Returns:
the menu item visibility mode for the given mode value

addMessageKey

public CmsMenuItemVisibilityMode addMessageKey(java.lang.String messageKey)
Adds the name of the message key for the visibility mode.

Parameters:
messageKey - the name of the message key for the visibility mode
Returns:
an extended visibility mode containing the message key

getMessageKey

public java.lang.String getMessageKey()
Returns the name of the message key for the visibility mode.

Is usually used as description for the inactive visibility modes.

Returns:
the name of the message key for the visibility mode

isActive

public boolean isActive()
Returns if the mode is set to VISIBILITY_ACTIVE.

Returns:
true if the mode is set to VISIBILITY_ACTIVE, otherwise false

isInActive

public boolean isInActive()
Returns if the mode is set to VISIBILITY_INACTIVE.

Returns:
true if the mode is set to VISIBILITY_INACTIVE, otherwise false

isInVisible

public boolean isInVisible()
Returns if the mode is set to VISIBILITY_INVISIBLE.

Returns:
true if the mode is set to VISIBILITY_INVISIBLE, otherwise false

clone

protected java.lang.Object clone()
See Also:
Object.clone()