Package org.opencms.ui.contextmenu

Class CmsStandardVisibilityCheck

java.lang.Object

org.opencms.ui.contextmenu.A_CmsSimpleVisibilityCheck

org.opencms.ui.contextmenu.CmsStandardVisibilityCheck

All Implemented Interfaces:

I_CmsHasMenuItemVisibility

public final class CmsStandardVisibilityCheck
extends A_CmsSimpleVisibilityCheck

Standard visibility check implementation.

Instances of this class are configured with a set of flags, each of which corresponds to a check to perform which may cause the context menu item to be hidden or deactivated.

Field Summary

Fields

Modifier and Type	Field	Description
static final CmsStandardVisibilityCheck	COPY_PAGE	Default visibility check for 'edit-like' operations on folders.
static final CmsStandardVisibilityCheck	DEFAULT	Default visibility check for 'edit-like' operations on resources.
static final I_CmsHasMenuItemVisibility	DEFAULT_AUTHOR	Default permissions but with 'element author' role requirement instead of 'editor'
static final I_CmsHasMenuItemVisibility	DEFAULT_DEFAULTFILE	Check for operations which need a default file.
static final CmsStandardVisibilityCheck	DEFAULT_FOLDERS	Default visibility check for 'edit-like' operations on folders.
static final CmsStandardVisibilityCheck	EDIT	Like DEFAULT, but only active for files.
static final CmsStandardVisibilityCheck	EDIT_CODE	Like DEFAULT, but only active for files.
static final I_CmsHasMenuItemVisibility	EDIT_POINTER	Visibility check for editing external links (pointers).
static final CmsStandardVisibilityCheck	LOCK	Check for locking resources.
static final CmsStandardVisibilityCheck	OTHER_PROJECT	Visibility check used for copy to project dialog.
static final I_CmsHasMenuItemVisibility	PERMISSIONS	Visibility check for the permissions dialog.
static final CmsStandardVisibilityCheck	PUBLISH	Visibility check for publish option.
static final CmsStandardVisibilityCheck	REINDEX	Visibility check for the reindex function.
static final CmsStandardVisibilityCheck	REPLACE	Check for the 'replace' operation.
static final CmsStandardVisibilityCheck	REPLACE_AUTHOR	'Replace' check, but with 'element author' role requirement instead of 'editor'.
static final CmsStandardVisibilityCheck	SHOW_LOCKS	Default check for 'locked resources' action.
static final I_CmsHasMenuItemVisibility	STEAL_LOCK	Permission check for stealing locks.
static final CmsStandardVisibilityCheck	UNDELETE	Visibility check for undelete option.
static final CmsStandardVisibilityCheck	UNDO	Visibility check for the undo function.
static final CmsStandardVisibilityCheck	UNDO_AUTHOR	Visibility check for the undo function.
static final CmsStandardVisibilityCheck	UNLOCK	Visibility check for the undo function.
static final CmsStandardVisibilityCheck	VIEW	Default visibility check for view operations on resources.
static final CmsStandardVisibilityCheck	VIEW_AUTHOR	Default visibility check for view operations on resources.
static final I_CmsHasMenuItemVisibility	VISIBLE	Always active.

Fields inherited from class org.opencms.ui.contextmenu.A_CmsSimpleVisibilityCheck

m_singleResourceOnly

Constructor Summary

Constructors

Constructor	Description
CmsStandardVisibilityCheck(CmsVisibilityCheckFlag... flags)	Creates a new instance using the given flags.

Method Summary

Modifier and Type	Method	Description
boolean	flag(CmsVisibilityCheckFlag flag)	Helper method to make checking for a flag very short (character count).
CmsMenuItemVisibilityMode	getSingleVisibility(CmsObject cms, CmsResource resource)	Computes visibility of the menu item for a single resource.
CmsMenuItemVisibilityMode	getVisibility(I_CmsDialogContext context)	Gets the visibility for the current dialog context.
String	toString()

Methods inherited from class org.opencms.ui.contextmenu.A_CmsSimpleVisibilityCheck

getVisibility

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

COPY_PAGE

public static final CmsStandardVisibilityCheck COPY_PAGE

Default visibility check for 'edit-like' operations on folders.

DEFAULT

public static final CmsStandardVisibilityCheck DEFAULT

Default visibility check for 'edit-like' operations on resources.

DEFAULT_AUTHOR

public static final I_CmsHasMenuItemVisibility DEFAULT_AUTHOR

Default permissions but with 'element author' role requirement instead of 'editor'

DEFAULT_DEFAULTFILE

public static final I_CmsHasMenuItemVisibility DEFAULT_DEFAULTFILE

Check for operations which need a default file.

DEFAULT_FOLDERS

public static final CmsStandardVisibilityCheck DEFAULT_FOLDERS

Default visibility check for 'edit-like' operations on folders.

EDIT

public static final CmsStandardVisibilityCheck EDIT

Like DEFAULT, but only active for files.

EDIT_CODE

public static final CmsStandardVisibilityCheck EDIT_CODE

Like DEFAULT, but only active for files.

EDIT_POINTER

public static final I_CmsHasMenuItemVisibility EDIT_POINTER

Visibility check for editing external links (pointers).

LOCK

public static final CmsStandardVisibilityCheck LOCK

Check for locking resources.

OTHER_PROJECT

public static final CmsStandardVisibilityCheck OTHER_PROJECT

Visibility check used for copy to project dialog.

PERMISSIONS

public static final I_CmsHasMenuItemVisibility PERMISSIONS

Visibility check for the permissions dialog.

PUBLISH

public static final CmsStandardVisibilityCheck PUBLISH

Visibility check for publish option.

REINDEX

public static final CmsStandardVisibilityCheck REINDEX

Visibility check for the reindex function.

REPLACE

public static final CmsStandardVisibilityCheck REPLACE

Check for the 'replace' operation.

REPLACE_AUTHOR

public static final CmsStandardVisibilityCheck REPLACE_AUTHOR

'Replace' check, but with 'element author' role requirement instead of 'editor'.

SHOW_LOCKS

public static final CmsStandardVisibilityCheck SHOW_LOCKS

Default check for 'locked resources' action.

STEAL_LOCK

public static final I_CmsHasMenuItemVisibility STEAL_LOCK

Permission check for stealing locks.

UNDELETE

public static final CmsStandardVisibilityCheck UNDELETE

Visibility check for undelete option.

UNDO

public static final CmsStandardVisibilityCheck UNDO

Visibility check for the undo function.

UNDO_AUTHOR

public static final CmsStandardVisibilityCheck UNDO_AUTHOR

Visibility check for the undo function.

UNLOCK

public static final CmsStandardVisibilityCheck UNLOCK

Visibility check for the undo function.

VIEW

public static final CmsStandardVisibilityCheck VIEW

Default visibility check for view operations on resources.

VIEW_AUTHOR

public static final CmsStandardVisibilityCheck VIEW_AUTHOR

Default visibility check for view operations on resources.

VISIBLE

public static final I_CmsHasMenuItemVisibility VISIBLE

Always active.

Constructor Details

CmsStandardVisibilityCheck

public CmsStandardVisibilityCheck(CmsVisibilityCheckFlag... flags)

Creates a new instance using the given flags.

Note that the order of the flags does not matter; the checks corresponding to the flags are performed in a fixed order.

Parameters:

flags - the flags indicating which checks to perform

Method Details

flag

public boolean flag(CmsVisibilityCheckFlag flag)

Helper method to make checking for a flag very short (character count).

Parameters:

flag - the flag to check

Returns:

true if this instance was configured with the given flag

getSingleVisibility

public CmsMenuItemVisibilityMode getSingleVisibility(CmsObject cms,
 CmsResource resource)

Description copied from class: A_CmsSimpleVisibilityCheck

Computes visibility of the menu item for a single resource.

Specified by:

getSingleVisibility in class A_CmsSimpleVisibilityCheck

Parameters:

cms - the CMS context to use

resource - the resource to check

Returns:

the visibility for the given resource

See Also:

• A_CmsSimpleVisibilityCheck.getSingleVisibility(org.opencms.file.CmsObject, org.opencms.file.CmsResource)

getVisibility

public CmsMenuItemVisibilityMode getVisibility(I_CmsDialogContext context)

Description copied from interface: I_CmsHasMenuItemVisibility

Gets the visibility for the current dialog context.

Parameters:

context - the dialog context

Returns:

the visibility

See Also:

• I_CmsHasMenuItemVisibility.getVisibility(org.opencms.ui.I_CmsDialogContext)

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()