io.wcm.config.editor

Enum WidgetTypes

java.lang.Object

java.lang.Enum<WidgetTypes>

io.wcm.config.editor.WidgetTypes

All Implemented Interfaces:

Serializable, Comparable<WidgetTypes>

public enum WidgetTypes
extends Enum<WidgetTypes>

Provides available widget types and their default configurations

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHECKBOX Checkbox widget.
MAP Text Multifield widget, which allows to specify multiple values for a property.
PATHBROWSER Path Browser widget with autocomplete function.
TEXT_MULTIFIELD Text Multifield widget, which allows to specify multiple values for a property.
TEXTAREA Text Area widget.
TEXTFIELD Text Field widget.

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getDefaultWidgetConfiguration()
Map<String,Object>	getWidgetConfiguration(Map<String,Object> defaultOverrides)
static WidgetTypes	valueOf(String name) Returns the enum constant of this type with the specified name.
static WidgetTypes[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TEXTFIELD

public static final WidgetTypes TEXTFIELD

Text Field widget. Following properties are available for configuration (all empty per default):

• required = true or false
• maxlength = integer value
• minlength = integer value
• pattern = regular expression for the value validation. E.g. /^[0-9]*$/

TEXT_MULTIFIELD

public static final WidgetTypes TEXT_MULTIFIELD

Text Multifield widget, which allows to specify multiple values for a property. Following properties are available for configuration (all empty per default):

• required = true or false
• maxlength = integer value
• minlength = integer value
• pattern = regular expression for the value validation. E.g. /^[0-9]*$/

TEXTAREA

public static final WidgetTypes TEXTAREA

Text Area widget. Following properties are available for configuration (all empty per default):

• required = true or false
• maxlength = integer value
• minlength = integer value
• pattern = regular expression for the value validation. E.g. /^[0-9]*$/

MAP

public static final WidgetTypes MAP

Text Multifield widget, which allows to specify multiple values for a property. Following properties are available for configuration (all empty per default):

• required = true or false
• maxlength = integer value
• minlength = integer value
• pattern = regular expression for the value validation. E.g. /^[0-9]*$/

PATHBROWSER

public static final WidgetTypes PATHBROWSER

Path Browser widget with autocomplete function. Following properties are available for configuration (all empty per default):

• required = true or false
• rootPath = root path from where pages can be selected. Default: /content

CHECKBOX

public static final WidgetTypes CHECKBOX

Checkbox widget. Following properties are available for configuration (all empty per default):

• required = true or false

Method Detail

values

public static WidgetTypes[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (WidgetTypes c : WidgetTypes.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static WidgetTypes valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getWidgetConfiguration

public Map<String,Object> getWidgetConfiguration(Map<String,Object> defaultOverrides)

Parameters:

defaultOverrides - Default overrides

Returns:

configuration properties of the widget with overridden default values

getDefaultWidgetConfiguration

public Map<String,Object> getDefaultWidgetConfiguration()

Returns:

configuration properties of the widget