Package org.opencms.gwt.shared

Class CmsGwtConstants

java.lang.Object

org.opencms.gwt.shared.CmsGwtConstants

public final class CmsGwtConstants
extends Object

Common constants needed for client side code.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CmsGwtConstants.Favorites	Parameters for favorite dialog.
static final class	CmsGwtConstants.QuickLaunch	Quick launcher constants.
static final class	CmsGwtConstants.RpcContext

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACTION_EDITSMALLELEMENTS	Context menu action id.
static final String	ACTION_PARAM_DIALOG_ID	Context menu action parameter dialog id.
static final String	ACTION_SELECTELEMENTVIEW	Context menu action id.
static final String	ACTION_SHOWLOCALE	Context menu action id.
static final String	ACTION_TEMPLATECONTEXTS	Context menu action id.
static final String	ACTION_TEMPLATECONTEXTS_ADVANCED	Context menu action id.
static final String	ACTION_VIEW_ONLINE	Context menu action id.
static final String	ATTR_CONTAINER_ID	Attribute for container id.
static final String	ATTR_CONTENT_EDITOR_LOCALE	JS property for accessing content editor locale from nested iframes.
static final String	ATTR_DATA_COLLECTOR	Collector data attribute name.
static final String	ATTR_DATA_CONTAINER	Container data attribute name.
static final String	ATTR_DATA_EDITABLE	Editable data attribute name.
static final String	ATTR_DATA_ELEMENT	Element data attribute name.
static final String	ATTR_DATA_FIELD	Content field data attribute name.
static final String	ATTR_DATA_ID	Entity id data attribute name.
static final String	ATTR_DATA_LISTADD	Name for the attribute used to store list-add metadata.
static final String	ATTR_DEAD_LINK_MARKER	Marker attribute for dead links.
static final String	ATTR_ELEMENT_ID	Key for the element id attribute.
static final String	ATTR_EXTENSIONS
static final String	ATTR_FAVORITE	Element data to enable / disable the favorite button.
static final String	ATTR_PAGE_ROOT_PATH	Key for the page root path attribute.
static final String	BROKEN_IMAGE	Data URL for 'broken image' image.
static final String	CALLBACK_HANDLE_CHANGED_PROPERTIES	Name of the Javascript callback used to handle property changes triggered from the locale compare view.
static final String	CALLBACK_REFRESH_LOCALE_COMPARISON	Javascript function name for showing the locale compare view.
static final String	CLASS_COLLECTOR_INFO	The CSS class name used for the DOM elements containing collector information.
static final String	CLASS_CONTAINER_INFLATED	CSS class for containers inflated due to an element dragged into them that is of lower height than the empty container HTML.
static final String	CLASS_DETAIL_PREVIEW	CSS class for elements in detail containers which are used to transfer their settings to the detail eleemnt.
static final String	CLASS_EDITABLE	The CSS class name for data elements which precede the direct editable elements.
static final String	CLASS_EDITABLE_END	The CSS class name for elements which end the direct editable elements.
static final String	CLASS_EDITABLE_SKIP	The CSS class name for elements which mark elements to be skipped during direct edit.
static final String	CLASS_PLACEHOLDER_TOO_BIG	Class for dnd placeholders which are too big.
static final String	COLLECTOR_PUBLISH_LIST_LIMIT	Name for configuration setting to limit collector results while computing publish lists for collectors.
static final String	CONTEXT_TYPE_APP_TOOLBAR	The context type sitemap toolbar.
static final String	CONTEXT_TYPE_CONTAINERPAGE_TOOLBAR	The context type containerpage toolbar.
static final String	CONTEXT_TYPE_FILE_TABLE	The context type file table.
static final String	CONTEXT_TYPE_SITEMAP_TOOLBAR	The context type sitemap toolbar.
static final String	DEFAULT_DETAILPAGE_TYPE	Special 'type' name (that isn't actually a type) used to mark default detail pages in the sitemap configuration.
static final String	EDITOR_PAGE_ID
static final String	FORMATTER_RELOAD_MARKER	A HTML comment that will cause the container page editor to reload the page if it is contained in HTML which is reloaded after the element or its settings have been edited.
static final String	FORMATTER_SUBKEY_SEPARATOR	Separator for separating the main part of a formatter key from the sub-key (the part in front of the separator will be used as a key if there is no formatter for the full key).
static final String	HANDLER_UNLOCK_PAGE	Sub-path for the page unlock service.
static final String	HANDLER_UPDATE_SESSION	Sub-path for the session update handler.
static final String	HIDDEN_SETTINGS_WIDGET_NAME	The settings widget name for hidden entries.
static final String	ID_LOCALE_COMPARISON	Element id for locale comparison view.
static final String	ID_LOCALE_HEADER_CONTAINER	Id of the element ussed to display the sitemap header from Vaadin code.
static final String	JSON_INPUT_LOCALE	Json field name for typograf locale passed to input widget.
static final String	JSON_INPUT_TYPOGRAF	Json field name for enabling typograf, passed to input widget.
static final String	JSON_TEXTAREA_CONFIG	Field name for the internal textarea configuration.
static final String	JSON_TEXTAREA_LOCALE	Field name for the internal textarea configuration.
static final String	LAST_CONTAINER_PAGE_ID	Session storage key for memorizing the last opened container page.
static final String	LOCALECOMPARE_EDIT_PROPERTIES	Name of the Javascript callback used to open the locale comparison view.
static final int	MAX_PLACEHOLDER_HEIGHT	The maximum DND placeholder height.
static final String	META_EDITOR_STYLESHEET	Name of the meta tag used to set the editor stylesheet.
static final String	PARAM_ADE_DETAIL_ID	Parameter to pass detail id to page editor context menu actions.
static final String	PARAM_BUTTON_LEFT	Parameter for the button left position.
static final String	PARAM_DISABLE_DIRECT_EDIT	Parameter to disable direct edit.
static final String	PARAM_LOGIN_REDIRECT	Name of the request parameter used to store the redirect target after login.
static final String	PARAM_TEMPLATE_CONTEXT	Parameter to force a specific template context.
static final String	PREFILL_MENU_PLACEHOLDER	Marker for the 'prefill' context menu action.
static final String	PROPERTY_IMAGE_FOCALPOINT	Name of property containing focal point for images.
static final String	TAB_BASIC	Tab id for the preference dialog.
static final String	TAB_EXTENDED	Tab id for the preference dialog.
static final String	TAB_HIDDEN	Tab id for the preference dialog.
static final String	TAG_OC_EDITPOINT	Tag name for the edit button bars injected into the page HTML in the container page editor.
static final String	TAG_OC_HIDDEN_ELEMENT	Custom tag for elements which were hidden because of mismatching device constraint.
static final String	TAG_OC_LISTADD	Tag name for the list-add metadata injected into the page.
static final String	TEMPLATECONTEXT_MENU_PLACEHOLDER	Action placeholder for the template contexts menu option.
static final String	TYPE_CONTAINERPAGE	Type name for container pages.
static final String	TYPE_ICON_CLASS	The resource icon CSS class prefix.
static final String	TYPE_IMAGE	The image resource type name.
static final String	TYPE_MODELGROUP	Name for the pseudo-type 'modelgroup'.
static final String	TYPE_MODELGROUP_COPY	Name for the pseudo-type 'modelgroupreuse'.
static final String	TYPE_MODELGROUP_PAGE	Name for the pseudo-type 'modelgrouppage'.
static final String	TYPE_MODELPAGE	Name for the type 'modelpage'.
static final String	TYPE_NAVLEVEL	Name for the pseudo-type 'navlevel'.
static final String	UNLOCK_FILE_PREFIX	Part of the URL used to unlock files.
static final String	VAR_LOCALE_ROOT	Name of Javascript variable used to hold the structure id of the currently selected locale's root folder in the sitemap editor's locale comparison mode.

Method Summary

Modifier and Type	Method	Description
static String	getPlaceholderMaxHeight()	Maximum DND placeholder height, as a string for stylesheets.

Methods inherited from class java.lang.Object

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

Field Details

ACTION_EDITSMALLELEMENTS

public static final String ACTION_EDITSMALLELEMENTS

Context menu action id.

See Also:

• Constant Field Values

ACTION_PARAM_DIALOG_ID

public static final String ACTION_PARAM_DIALOG_ID

Context menu action parameter dialog id.

See Also:

• Constant Field Values

ACTION_SELECTELEMENTVIEW

public static final String ACTION_SELECTELEMENTVIEW

Context menu action id.

See Also:

• Constant Field Values

ACTION_SHOWLOCALE

public static final String ACTION_SHOWLOCALE

Context menu action id.

See Also:

• Constant Field Values

ACTION_TEMPLATECONTEXTS

public static final String ACTION_TEMPLATECONTEXTS

Context menu action id.

See Also:

• Constant Field Values

ACTION_TEMPLATECONTEXTS_ADVANCED

public static final String ACTION_TEMPLATECONTEXTS_ADVANCED

Context menu action id.

See Also:

• Constant Field Values

ACTION_VIEW_ONLINE

public static final String ACTION_VIEW_ONLINE

Context menu action id.

See Also:

• Constant Field Values

ATTR_CONTAINER_ID

public static final String ATTR_CONTAINER_ID

Attribute for container id.

See Also:

• Constant Field Values

ATTR_CONTENT_EDITOR_LOCALE

public static final String ATTR_CONTENT_EDITOR_LOCALE

JS property for accessing content editor locale from nested iframes.

See Also:

• Constant Field Values

ATTR_DATA_COLLECTOR

public static final String ATTR_DATA_COLLECTOR

Collector data attribute name.

See Also:

• Constant Field Values

ATTR_DATA_CONTAINER

public static final String ATTR_DATA_CONTAINER

Container data attribute name.

See Also:

• Constant Field Values

ATTR_DATA_EDITABLE

public static final String ATTR_DATA_EDITABLE

Editable data attribute name.

See Also:

• Constant Field Values

ATTR_DATA_ELEMENT

public static final String ATTR_DATA_ELEMENT

Element data attribute name.

See Also:

• Constant Field Values

ATTR_DATA_FIELD

public static final String ATTR_DATA_FIELD

Content field data attribute name.

See Also:

• Constant Field Values

ATTR_DATA_ID

public static final String ATTR_DATA_ID

Entity id data attribute name.

See Also:

• Constant Field Values

ATTR_DATA_LISTADD

public static final String ATTR_DATA_LISTADD

Name for the attribute used to store list-add metadata.

See Also:

• Constant Field Values

ATTR_DEAD_LINK_MARKER

public static final String ATTR_DEAD_LINK_MARKER

Marker attribute for dead links.

See Also:

• Constant Field Values

ATTR_ELEMENT_ID

public static final String ATTR_ELEMENT_ID

Key for the element id attribute.

See Also:

• Constant Field Values

ATTR_EXTENSIONS

public static final String ATTR_EXTENSIONS

See Also:

• Constant Field Values

ATTR_FAVORITE

public static final String ATTR_FAVORITE

Element data to enable / disable the favorite button.

See Also:

• Constant Field Values

ATTR_PAGE_ROOT_PATH

public static final String ATTR_PAGE_ROOT_PATH

Key for the page root path attribute.

See Also:

• Constant Field Values

BROKEN_IMAGE

public static final String BROKEN_IMAGE

Data URL for 'broken image' image.

See Also:

• Constant Field Values

CALLBACK_HANDLE_CHANGED_PROPERTIES

public static final String CALLBACK_HANDLE_CHANGED_PROPERTIES

Name of the Javascript callback used to handle property changes triggered from the locale compare view.

See Also:

• Constant Field Values

CALLBACK_REFRESH_LOCALE_COMPARISON

public static final String CALLBACK_REFRESH_LOCALE_COMPARISON

Javascript function name for showing the locale compare view.

See Also:

• Constant Field Values

CLASS_COLLECTOR_INFO

public static final String CLASS_COLLECTOR_INFO

The CSS class name used for the DOM elements containing collector information.

See Also:

• Constant Field Values

CLASS_CONTAINER_INFLATED

public static final String CLASS_CONTAINER_INFLATED

CSS class for containers inflated due to an element dragged into them that is of lower height than the empty container HTML.

See Also:

• Constant Field Values

CLASS_DETAIL_PREVIEW

public static final String CLASS_DETAIL_PREVIEW

CSS class for elements in detail containers which are used to transfer their settings to the detail eleemnt.

See Also:

• Constant Field Values

CLASS_EDITABLE

public static final String CLASS_EDITABLE

The CSS class name for data elements which precede the direct editable elements.

See Also:

• Constant Field Values

CLASS_EDITABLE_END

public static final String CLASS_EDITABLE_END

The CSS class name for elements which end the direct editable elements.

See Also:

• Constant Field Values

CLASS_EDITABLE_SKIP

public static final String CLASS_EDITABLE_SKIP

The CSS class name for elements which mark elements to be skipped during direct edit.

See Also:

• Constant Field Values

CLASS_PLACEHOLDER_TOO_BIG

public static final String CLASS_PLACEHOLDER_TOO_BIG

Class for dnd placeholders which are too big.

See Also:

• Constant Field Values

COLLECTOR_PUBLISH_LIST_LIMIT

public static final String COLLECTOR_PUBLISH_LIST_LIMIT

Name for configuration setting to limit collector results while computing publish lists for collectors.

See Also:

• Constant Field Values

CONTEXT_TYPE_APP_TOOLBAR

public static final String CONTEXT_TYPE_APP_TOOLBAR

The context type sitemap toolbar.

See Also:

• Constant Field Values

CONTEXT_TYPE_CONTAINERPAGE_TOOLBAR

public static final String CONTEXT_TYPE_CONTAINERPAGE_TOOLBAR

The context type containerpage toolbar.

See Also:

• Constant Field Values

CONTEXT_TYPE_FILE_TABLE

public static final String CONTEXT_TYPE_FILE_TABLE

The context type file table.

See Also:

• Constant Field Values

CONTEXT_TYPE_SITEMAP_TOOLBAR

public static final String CONTEXT_TYPE_SITEMAP_TOOLBAR

The context type sitemap toolbar.

See Also:

• Constant Field Values

DEFAULT_DETAILPAGE_TYPE

public static final String DEFAULT_DETAILPAGE_TYPE

Special 'type' name (that isn't actually a type) used to mark default detail pages in the sitemap configuration.

See Also:

• Constant Field Values

EDITOR_PAGE_ID

public static final String EDITOR_PAGE_ID

See Also:

• Constant Field Values

FORMATTER_RELOAD_MARKER

public static final String FORMATTER_RELOAD_MARKER

A HTML comment that will cause the container page editor to reload the page if it is contained in HTML which is reloaded after the element or its settings have been edited.

See Also:

• Constant Field Values

FORMATTER_SUBKEY_SEPARATOR

public static final String FORMATTER_SUBKEY_SEPARATOR

Separator for separating the main part of a formatter key from the sub-key (the part in front of the separator will be used as a key if there is no formatter for the full key).

See Also:

• Constant Field Values

HANDLER_UNLOCK_PAGE

public static final String HANDLER_UNLOCK_PAGE

Sub-path for the page unlock service.

See Also:

• Constant Field Values

HANDLER_UPDATE_SESSION

public static final String HANDLER_UPDATE_SESSION

Sub-path for the session update handler.

See Also:

• Constant Field Values

HIDDEN_SETTINGS_WIDGET_NAME

public static final String HIDDEN_SETTINGS_WIDGET_NAME

The settings widget name for hidden entries.

See Also:

• Constant Field Values

ID_LOCALE_COMPARISON

public static final String ID_LOCALE_COMPARISON

Element id for locale comparison view.

See Also:

• Constant Field Values

ID_LOCALE_HEADER_CONTAINER

public static final String ID_LOCALE_HEADER_CONTAINER

Id of the element ussed to display the sitemap header from Vaadin code.

See Also:

• Constant Field Values

JSON_INPUT_LOCALE

public static final String JSON_INPUT_LOCALE

Json field name for typograf locale passed to input widget.

See Also:

• Constant Field Values

JSON_INPUT_TYPOGRAF

public static final String JSON_INPUT_TYPOGRAF

Json field name for enabling typograf, passed to input widget.

See Also:

• Constant Field Values

JSON_TEXTAREA_CONFIG

public static final String JSON_TEXTAREA_CONFIG

Field name for the internal textarea configuration.

See Also:

• Constant Field Values

JSON_TEXTAREA_LOCALE

public static final String JSON_TEXTAREA_LOCALE

Field name for the internal textarea configuration.

See Also:

• Constant Field Values

LAST_CONTAINER_PAGE_ID

public static final String LAST_CONTAINER_PAGE_ID

Session storage key for memorizing the last opened container page.

See Also:

• Constant Field Values

LOCALECOMPARE_EDIT_PROPERTIES

public static final String LOCALECOMPARE_EDIT_PROPERTIES

Name of the Javascript callback used to open the locale comparison view.

See Also:

• Constant Field Values

MAX_PLACEHOLDER_HEIGHT

public static final int MAX_PLACEHOLDER_HEIGHT

The maximum DND placeholder height.

See Also:

• Constant Field Values

META_EDITOR_STYLESHEET

public static final String META_EDITOR_STYLESHEET

Name of the meta tag used to set the editor stylesheet.

See Also:

• Constant Field Values

PARAM_ADE_DETAIL_ID

public static final String PARAM_ADE_DETAIL_ID

Parameter to pass detail id to page editor context menu actions.

See Also:

• Constant Field Values

PARAM_BUTTON_LEFT

public static final String PARAM_BUTTON_LEFT

Parameter for the button left position.

See Also:

• Constant Field Values

PARAM_DISABLE_DIRECT_EDIT

public static final String PARAM_DISABLE_DIRECT_EDIT

Parameter to disable direct edit.

See Also:

• Constant Field Values

PARAM_LOGIN_REDIRECT

public static final String PARAM_LOGIN_REDIRECT

Name of the request parameter used to store the redirect target after login.

See Also:

• Constant Field Values

PARAM_TEMPLATE_CONTEXT

public static final String PARAM_TEMPLATE_CONTEXT

Parameter to force a specific template context.

See Also:

• Constant Field Values

PREFILL_MENU_PLACEHOLDER

public static final String PREFILL_MENU_PLACEHOLDER

Marker for the 'prefill' context menu action.

See Also:

• Constant Field Values

PROPERTY_IMAGE_FOCALPOINT

public static final String PROPERTY_IMAGE_FOCALPOINT

Name of property containing focal point for images.

See Also:

• Constant Field Values

TAB_BASIC

public static final String TAB_BASIC

Tab id for the preference dialog.

See Also:

• Constant Field Values

TAB_EXTENDED

public static final String TAB_EXTENDED

Tab id for the preference dialog.

See Also:

• Constant Field Values

TAB_HIDDEN

public static final String TAB_HIDDEN

Tab id for the preference dialog.

See Also:

• Constant Field Values

TAG_OC_EDITPOINT

public static final String TAG_OC_EDITPOINT

Tag name for the edit button bars injected into the page HTML in the container page editor.

See Also:

• Constant Field Values

TAG_OC_HIDDEN_ELEMENT

public static final String TAG_OC_HIDDEN_ELEMENT

Custom tag for elements which were hidden because of mismatching device constraint.

See Also:

• Constant Field Values

TAG_OC_LISTADD

public static final String TAG_OC_LISTADD

Tag name for the list-add metadata injected into the page.

See Also:

• Constant Field Values

TEMPLATECONTEXT_MENU_PLACEHOLDER

public static final String TEMPLATECONTEXT_MENU_PLACEHOLDER

Action placeholder for the template contexts menu option.

See Also:

• Constant Field Values

TYPE_CONTAINERPAGE

public static final String TYPE_CONTAINERPAGE

Type name for container pages.

See Also:

• Constant Field Values

TYPE_ICON_CLASS

public static final String TYPE_ICON_CLASS

The resource icon CSS class prefix.

See Also:

• Constant Field Values

TYPE_IMAGE

public static final String TYPE_IMAGE

The image resource type name.

See Also:

• Constant Field Values

TYPE_MODELGROUP

public static final String TYPE_MODELGROUP

Name for the pseudo-type 'modelgroup'.

See Also:

• Constant Field Values

TYPE_MODELGROUP_COPY

public static final String TYPE_MODELGROUP_COPY

Name for the pseudo-type 'modelgroupreuse'.

See Also:

• Constant Field Values

TYPE_MODELGROUP_PAGE

public static final String TYPE_MODELGROUP_PAGE

Name for the pseudo-type 'modelgrouppage'.

See Also:

• Constant Field Values

TYPE_MODELPAGE

public static final String TYPE_MODELPAGE

Name for the type 'modelpage'.

See Also:

• Constant Field Values

TYPE_NAVLEVEL

public static final String TYPE_NAVLEVEL

Name for the pseudo-type 'navlevel'.

See Also:

• Constant Field Values

UNLOCK_FILE_PREFIX

public static final String UNLOCK_FILE_PREFIX

Part of the URL used to unlock files.

See Also:

• Constant Field Values

VAR_LOCALE_ROOT

public static final String VAR_LOCALE_ROOT

Name of Javascript variable used to hold the structure id of the currently selected locale's root folder in the sitemap editor's locale comparison mode.

See Also:

• Constant Field Values

Method Details

getPlaceholderMaxHeight

public static String getPlaceholderMaxHeight()

Maximum DND placeholder height, as a string for stylesheets.

Returns:

the maximum DND placeholder height as a string