org.nuxeo.ecm.platform.forms.layout.api

Class BuiltinModes

java.lang.Object

org.nuxeo.ecm.platform.forms.layout.api.BuiltinModes

public class BuiltinModes
extends Object

List of built-in modes.

Author:

Anahide Tchertchian

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANY
static String	BULK_EDIT
static String	CREATE
static String	CSV
static String	DEV
static String	EDIT
protected static String	HEADER Deprecated.
static String	LISTING Deprecated.
static String	PDF
static String	PLAIN
static String	SEARCH
static String	SUMMARY
static String	VIEW

Method Summary

Modifier and Type	Method and Description
static String	getWidgetModeFromLayoutMode(String layoutMode) Returns the default mode to use for a widget, given the layout mode.
static boolean	isBoundToEditMode(String layoutMode) Returns true if given layout mode is mapped by default to the edit widget mode.

Methods inherited from class java.lang.Object

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

Field Detail

ANY

public static final String ANY

See Also:

Constant Field Values

VIEW

public static final String VIEW

See Also:

Constant Field Values

EDIT

public static final String EDIT

See Also:

Constant Field Values

BULK_EDIT

public static final String BULK_EDIT

See Also:

Constant Field Values

CREATE

public static final String CREATE

See Also:

Constant Field Values

SEARCH

public static final String SEARCH

See Also:

Constant Field Values

LISTING

@Deprecated
public static final String LISTING

Deprecated.

See Also:

Constant Field Values

SUMMARY

public static final String SUMMARY

See Also:

Constant Field Values

HEADER

@Deprecated
protected static final String HEADER

Deprecated.

Since:

5.4.2

See Also:

Constant Field Values

CSV

public static final String CSV

Since:

5.4.2

See Also:

Constant Field Values

PDF

public static final String PDF

Since:

5.4.2

See Also:

Constant Field Values

PLAIN

public static final String PLAIN

Since:

5.4.2

See Also:

Constant Field Values

DEV

public static final String DEV

Since:

6.0

See Also:

Constant Field Values

Method Detail

isBoundToEditMode

public static boolean isBoundToEditMode(String layoutMode)

Returns true if given layout mode is mapped by default to the edit widget mode.

getWidgetModeFromLayoutMode

public static String getWidgetModeFromLayoutMode(String layoutMode)

Returns the default mode to use for a widget, given the layout mode.

Returns BuiltinWidgetModes.EDIT for all modes bound to edit, BuiltinWidgetModes.VIEW for modes VIEW, HEADER and SUMMARY. PDF and CSV are respectively bound to BuiltinWidgetModes.PDF and BuiltinWidgetModes.CSV. In other cases, returns BuiltinWidgetModes.PLAIN.

This method is not called when mode is explicitely set on the widget.