org.nuxeo.ecm.platform.ui.select2.common

Class Select2Common

java.lang.Object

org.nuxeo.ecm.platform.ui.select2.common.Select2Common

public class Select2Common
extends Object

Group fields and methods used at initialization and runtime for select2 feature.

Since:

5.7.3

Field Summary

Fields

Modifier and Type	Field and Description
static String	AJAX_RERENDER
static String	COMPUTED_ID
static String	DEFAULT_KEY_SEPARATOR
static String	DEFAULT_LANG
static int	DEFAULT_MIN_CHARS
static String	DEFAULT_WIDTH
static String	DIR_DEFAULT_SELECTION_FORMATTER
static String	DIR_DEFAULT_SUGGESTION_FORMATTER
static String	DIRECTORY_DEFAULT_LABEL_COL_NAME
static String	DIRECTORY_ORDER_FIELD_NAME
static String	DISPLAY_ICON
static String	DOC_DEFAULT_SELECTION_FORMATTER
static String	DOC_DEFAULT_SUGGESTION_FORMATTER
static String	GROUP_TYPE
static String	ID
static String	LABEL
static String	LANG_TOKEN
static String	MIN_CHARS
static String	OBSOLETE_FIELD_ID
static String	OPERATION_ID
static String	PARENT_FIELD_ID
static String	PLACEHOLDER
static String	PREFIXED_ID_KEY_NAME
static String	READ_ONLY_PARAM
static String	RERENDER_JS_FUNCTION_NAME
static List<String>	SELECT2_DEFAULT_DOCUMENT_SCHEMAS
static List<String>	SELECT2_DIR_WIDGET_TYPE_LIST
static List<String>	SELECT2_DOC_WIDGET_TYPE_LIST
static List<String>	SELECT2_USER_WIDGET_TYPE_LIST
static String	SELECTION_FORMATTER
static String	SUGGESTION_FORMATTER
static String	TITLE
static String	TYPE_KEY_NAME
static String	USER_DEFAULT_SELECTION_FORMATTER
static String	USER_DEFAULT_SUGGESTION_FORMATTER
static String	USER_TYPE
static String	WARN_MESSAGE_LABEL
static String	WIDTH

Constructor Summary

Constructors

Constructor and Description
Select2Common()

Method Summary

Methods

Modifier and Type	Method and Description
static void	computeGroupLabel(net.sf.json.JSONObject obj, String groupId, String groupLabelField, boolean hideFirstLabel)
static void	computeUserGroupIcon(net.sf.json.JSONObject obj, boolean hideIcon)
static void	computeUserLabel(net.sf.json.JSONObject obj, String firstLabelField, String secondLabelField, String thirdLabelField, boolean hideFirstLabel, boolean hideSecondLabel, boolean hideThirdLabel, boolean displayEmailInSuggestion, String userId)
static String	getLabelFieldName(Schema schema, boolean dbl10n, String labelFieldName, String lang) Compute the field name of the directory that holds the value that we want to display.
static String[]	getSchemas(String schemaNames) Returns an array containing the given schema names plus the default ones if not included

Methods inherited from class java.lang.Object

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

Field Detail

LANG_TOKEN

public static final String LANG_TOKEN

See Also:

Constant Field Values

DEFAULT_LANG

public static final String DEFAULT_LANG

See Also:

Constant Field Values

ID

public static final String ID

See Also:

Constant Field Values

LABEL

public static final String LABEL

See Also:

Constant Field Values

DIRECTORY_DEFAULT_LABEL_COL_NAME

public static final String DIRECTORY_DEFAULT_LABEL_COL_NAME

See Also:

Constant Field Values

PARENT_FIELD_ID

public static final String PARENT_FIELD_ID

See Also:

Constant Field Values

PLACEHOLDER

public static final String PLACEHOLDER

See Also:

Constant Field Values

COMPUTED_ID

public static final String COMPUTED_ID

See Also:

Constant Field Values

DEFAULT_KEY_SEPARATOR

public static final String DEFAULT_KEY_SEPARATOR

See Also:

Constant Field Values

OBSOLETE_FIELD_ID

public static final String OBSOLETE_FIELD_ID

See Also:

Constant Field Values

SELECT2_USER_WIDGET_TYPE_LIST

public static final List<String> SELECT2_USER_WIDGET_TYPE_LIST

SELECT2_DOC_WIDGET_TYPE_LIST

public static final List<String> SELECT2_DOC_WIDGET_TYPE_LIST

USER_TYPE

public static final String USER_TYPE

See Also:

Constant Field Values

GROUP_TYPE

public static final String GROUP_TYPE

See Also:

Constant Field Values

TYPE_KEY_NAME

public static final String TYPE_KEY_NAME

See Also:

Constant Field Values

PREFIXED_ID_KEY_NAME

public static final String PREFIXED_ID_KEY_NAME

See Also:

Constant Field Values

SUGGESTION_FORMATTER

public static final String SUGGESTION_FORMATTER

See Also:

Constant Field Values

SELECTION_FORMATTER

public static final String SELECTION_FORMATTER

See Also:

Constant Field Values

USER_DEFAULT_SUGGESTION_FORMATTER

public static final String USER_DEFAULT_SUGGESTION_FORMATTER

See Also:

Constant Field Values

DOC_DEFAULT_SUGGESTION_FORMATTER

public static final String DOC_DEFAULT_SUGGESTION_FORMATTER

See Also:

Constant Field Values

WARN_MESSAGE_LABEL

public static final String WARN_MESSAGE_LABEL

See Also:

Constant Field Values

SELECT2_DIR_WIDGET_TYPE_LIST

public static final List<String> SELECT2_DIR_WIDGET_TYPE_LIST

SELECT2_DEFAULT_DOCUMENT_SCHEMAS

public static final List<String> SELECT2_DEFAULT_DOCUMENT_SCHEMAS

DIR_DEFAULT_SUGGESTION_FORMATTER

public static final String DIR_DEFAULT_SUGGESTION_FORMATTER

See Also:

Constant Field Values

READ_ONLY_PARAM

public static final String READ_ONLY_PARAM

See Also:

Constant Field Values

RERENDER_JS_FUNCTION_NAME

public static final String RERENDER_JS_FUNCTION_NAME

See Also:

Constant Field Values

AJAX_RERENDER

public static final String AJAX_RERENDER

See Also:

Constant Field Values

USER_DEFAULT_SELECTION_FORMATTER

public static final String USER_DEFAULT_SELECTION_FORMATTER

See Also:

Constant Field Values

DOC_DEFAULT_SELECTION_FORMATTER

public static final String DOC_DEFAULT_SELECTION_FORMATTER

See Also:

Constant Field Values

DIR_DEFAULT_SELECTION_FORMATTER

public static final String DIR_DEFAULT_SELECTION_FORMATTER

See Also:

Constant Field Values

WIDTH

public static final String WIDTH

See Also:

Constant Field Values

DEFAULT_WIDTH

public static final String DEFAULT_WIDTH

See Also:

Constant Field Values

MIN_CHARS

public static final String MIN_CHARS

See Also:

Constant Field Values

DEFAULT_MIN_CHARS

public static final int DEFAULT_MIN_CHARS

See Also:

Constant Field Values

TITLE

public static final String TITLE

See Also:

Constant Field Values

DISPLAY_ICON

public static final String DISPLAY_ICON

See Also:

Constant Field Values

OPERATION_ID

public static final String OPERATION_ID

See Also:

Constant Field Values

DIRECTORY_ORDER_FIELD_NAME

public static final String DIRECTORY_ORDER_FIELD_NAME

See Also:

Constant Field Values

Constructor Detail

Select2Common

public Select2Common()

Method Detail

getLabelFieldName

public static String getLabelFieldName(Schema schema,
                       boolean dbl10n,
                       String labelFieldName,
                       String lang)

Compute the field name of the directory that holds the value that we want to display.

Parameters:

schema - the directory schema

dbl10n - are translations carried by directory fields

labelFieldName - the name or pattern of the fields that held values

lang - the current language

Returns:

the final field name where we pick up the value

Throws:

IllegalArgumentException - when cannot compute label field name

Since:

5.7.3

getSchemas

public static String[] getSchemas(String schemaNames)

Returns an array containing the given schema names plus the default ones if not included

Parameters:

schemaNames -

Since:

5.8

computeUserLabel

public static void computeUserLabel(net.sf.json.JSONObject obj,
                    String firstLabelField,
                    String secondLabelField,
                    String thirdLabelField,
                    boolean hideFirstLabel,
                    boolean hideSecondLabel,
                    boolean hideThirdLabel,
                    boolean displayEmailInSuggestion,
                    String userId)

computeGroupLabel

public static void computeGroupLabel(net.sf.json.JSONObject obj,
                     String groupId,
                     String groupLabelField,
                     boolean hideFirstLabel)

computeUserGroupIcon

public static void computeUserGroupIcon(net.sf.json.JSONObject obj,
                        boolean hideIcon)