Package org.opencms.ui.contextmenu

Class CmsMenuItemVisibilityMode

java.lang.Object

org.opencms.util.A_CmsModeIntEnumeration

org.opencms.ui.contextmenu.CmsMenuItemVisibilityMode

All Implemented Interfaces:

Serializable

public final class CmsMenuItemVisibilityMode
extends A_CmsModeIntEnumeration

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

Since:

6.5.6

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final CmsMenuItemVisibilityMode	VISIBILITY_ACTIVE	Menu item visibility: active.
static final CmsMenuItemVisibilityMode	VISIBILITY_INACTIVE	Menu item visibility: inactive.
static final CmsMenuItemVisibilityMode	VISIBILITY_INVISIBLE	Menu item visibility: invisible.
static final CmsMenuItemVisibilityMode	VISIBILITY_USE_NEXT	Menu item visibility: invisible, use next best menu item with same ID.

Method Summary

Modifier and Type	Method	Description
static CmsMenuItemVisibilityMode	activeInactive(boolean active)	Utilitiy method that returns 'active' if the parameter is true, otherwise inactive.
static CmsMenuItemVisibilityMode	activeInvisible(boolean active)	Utility method that returns 'active' if the parameter is true, otherwise invisible.
CmsMenuItemVisibilityMode	addMessageKey(String messageKey)	Adds the name of the message key for the visibility mode.
protected CmsMenuItemVisibilityMode	clone()
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 or VISIBILITY_USE_NEXT.
boolean	isPrioritized()	Returns the prioritization flag.
boolean	isUseNext()	Returns true if this item is invisible, but the next best item with the same ID should be used instead.
CmsMenuItemVisibilityMode	prioritize(boolean prioritized)	Returns a prioritized instance of the visibility mode.
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 Details

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.

VISIBILITY_USE_NEXT

public static final CmsMenuItemVisibilityMode VISIBILITY_USE_NEXT

Menu item visibility: invisible, use next best menu item with same ID.

Method Details

activeInactive

public static CmsMenuItemVisibilityMode activeInactive(boolean active)

Utilitiy method that returns 'active' if the parameter is true, otherwise inactive.

Parameters:

active - - whether return value should be 'active'

Returns:

the visibility

activeInvisible

public static CmsMenuItemVisibilityMode activeInvisible(boolean active)

Utility method that returns 'active' if the parameter is true, otherwise invisible.

Parameters:

active - - whether return value should be 'active' rather than 'invisible'

Returns:

the visibility

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(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 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 or VISIBILITY_USE_NEXT.

Returns:

true if the mode is set to VISIBILITY_INVISIBLE or VISIBILITY_USE_NEXT, otherwise false

isPrioritized

public boolean isPrioritized()

Returns the prioritization flag.

Returns:

prioritization flag

isUseNext

public boolean isUseNext()

Returns true if this item is invisible, but the next best item with the same ID should be used instead.

Returns:

true if this item is invisible, but the next best item with the same ID should be used instead

prioritize

public CmsMenuItemVisibilityMode prioritize(boolean prioritized)

Returns a prioritized instance of the visibility mode.

Parameters:

prioritized - true to prioritize

Returns:

the new visibility mode instance

clone

protected CmsMenuItemVisibilityMode clone()

Overrides:

clone in class Object

See Also:

• Object.clone()