ListClass (XWiki Platform - Old Core 12.10.10 API)

java.lang.Object
- com.xpn.xwiki.objects.BaseElement<R>
- - com.xpn.xwiki.objects.BaseCollection<ClassPropertyReference>
  - - com.xpn.xwiki.objects.classes.PropertyClass
    - - com.xpn.xwiki.objects.classes.ListClass

All Implemented Interfaces:

PropertyClassInterface, ElementInterface, ObjectInterface, PropertyInterface, Serializable, Cloneable, Comparable<PropertyClass>

Direct Known Subclasses:

DBListClass, GroupsClass, LevelsClass, StaticListClass, UsersClass
```
public abstract class ListClass
extends PropertyClass
```
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class ListClass.MapComparator

Nested Classes
Modifier and Type	Class and Description
`protected class`	`ListClass.MapComparator`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_SEPARATOR` Default separator/delimiter to use to split or join a list stored as a string.
`static String`	`DISPLAYTYPE_CHECKBOX`
`static String`	`DISPLAYTYPE_INPUT`
`static String`	`DISPLAYTYPE_RADIO`
`static String`	`DISPLAYTYPE_SELECT`
`static String`	`FREE_TEXT_ALLOWED`
`static String`	`FREE_TEXT_DISCOURAGED`
`static String`	`FREE_TEXT_FORBIDDEN`
`static char`	`SEPARATOR_ESCAPE` Used to escape a separator character inside a string serialized list item.

Fields inherited from class com.xpn.xwiki.objects.classes.PropertyClass
cachedCustomDisplayer

Fields inherited from class com.xpn.xwiki.objects.BaseCollection
currentReferenceDocumentReferenceResolver, fields, fieldsToRemove, number, relativeEntityReferenceResolver

Fields inherited from class com.xpn.xwiki.objects.BaseElement
documentReference, ownerDocument, referenceCache

Constructor Summary

Constructors
Constructor and Description

ListClass()

ListClass(PropertyMetaClass wclass)

ListClass(String name, String prettyname, PropertyMetaClass wclass)

Constructors
Constructor and Description
`ListClass()`
`ListClass(PropertyMetaClass wclass)`
`ListClass(String name, String prettyname, PropertyMetaClass wclass)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`displayEdit(StringBuffer buffer, String name, String prefix, BaseCollection object, XWikiContext context)`
`void`	`displayHidden(StringBuffer buffer, String name, String prefix, BaseCollection object, XWikiContext context)`
`protected void`	`displayRadioEdit(StringBuffer buffer, String name, String prefix, BaseCollection object, XWikiContext context)`
`protected void`	`displaySelectEdit(StringBuffer buffer, String name, String prefix, BaseCollection object, XWikiContext context)`
`void`	`displayView(StringBuffer buffer, String name, String prefix, BaseCollection object, XWikiContext context)`
`void`	`fromList(BaseProperty<?> property, List<String> list)` Set the passed `List` into the passed property.
`BaseProperty`	`fromString(String value)`
`BaseProperty`	`fromStringArray(String[] strings)`
`String`	`getDefaultValue()`
`String`	`getDisplayType()`
`protected String`	`getDisplayValue(Object rawvalue, String name, Map<String,ListItem> map, XWikiContext context)` Search for an internationalizable display text for the current value.
`protected String`	`getDisplayValue(String value, String name, Map<String,ListItem> map, XWikiContext context)` Search for an internationalizable display text for the current value.
`protected String`	`getElementValue(Object rawvalue)` If the list is populated with value=name pairs selected from the database, then return only the value.
`String`	`getFreeText()`
`abstract List<String>`	`getList(XWikiContext context)`
`static List<String>`	`getListFromString(String value)` Convenience method, using "\|" as separator and parsing key=value items.
`static List<String>`	`getListFromString(String value, String separators, boolean withMap)`
`abstract Map<String,ListItem>`	`getMap(XWikiContext context)`
`static Map<String,ListItem>`	`getMapFromString(String value)`
`String`	`getSeparator()`
`String`	`getSeparators()`
`int`	`getSize()`
`String`	`getSort()`
`static String`	`getStringFromList(List<String> list)` Convenience method, using "\|" as separator.
`static String`	`getStringFromList(List<String> list, String separators)`
`boolean`	`isCache()`
`boolean`	`isLargeStorage()`
`boolean`	`isMultiSelect()`
`boolean`	`isPicker()`
`boolean`	`isRelationalStorage()`
`protected <T extends EntityReference> void`	`mergeNotOrderedListProperty(BaseProperty<T> currentProperty, BaseProperty<T> previousProperty, BaseProperty<T> newProperty, MergeConfiguration configuration, XWikiContext context, MergeResult mergeResult)`
`<T extends EntityReference> void`	`mergeProperty(BaseProperty<T> currentProperty, BaseProperty<T> previousProperty, BaseProperty<T> newProperty, MergeConfiguration configuration, XWikiContext context, MergeResult mergeResult)` Apply a 3 ways merge on passed current, previous and new version of the same property.
`BaseProperty`	`newProperty()`
`BaseProperty`	`newPropertyfromXML(org.dom4j.Element ppcel)`
`void`	`setCache(boolean cache)`
`void`	`setDefaultValue(String separator)`
`void`	`setDisplayType(String type)`
`void`	`setFreeText(String type)`
`void`	`setLargeStorage(boolean largeStorage)`
`void`	`setMultiSelect(boolean multiSelect)`
`void`	`setPicker(boolean picker)`
`void`	`setRelationalStorage(boolean relationalStorage)`
`void`	`setSeparator(String separator)`
`void`	`setSeparators(String separators)`
`void`	`setSize(int size)`
`void`	`setSort(String sort)`
`String`	`toFormString(BaseProperty property)` Used in `displayEdit(StringBuffer, String, String, BaseCollection, XWikiContext)`.
`List<String>`	`toList(BaseProperty<?> property)` `ListClass` does not produce only `ListProperty`s and this method allows to access the value as `List` whatever property is actually storing it.

Methods inherited from class com.xpn.xwiki.objects.classes.PropertyClass
clone, compareTo, createReference, displayCustom, displayEdit, displayEdit, displayHidden, displayHidden, displayView, displayView, flushCache, fromValue, fromXML, getCachedDefaultCustomDisplayer, getClassName, getClassType, getCustomDisplay, getDefaultCustomDisplayer, getFieldFullName, getFullQueryPropertyName, getHint, getId, getName, getNumber, getObject, getPrettyName, getPrettyName, getTooltip, getTooltip, getTranslatedPrettyName, getValidationMessage, getValidationRegExp, getXClass, getxWikiClass, initLazyCollections, isCustomDisplayed, isDisabled, isUnmodifiable, isValidColumnTypes, renderContentInContext, renderContentInContext, setClassType, setCustomDisplay, setDisabled, setHint, setId, setName, setNumber, setObject, setPrettyName, setTooltip, setUnmodifiable, setValidationMessage, setValidationRegExp, setxWikiClass, toFormString, toString, toXML, toXML, validateProperty

Methods inherited from class com.xpn.xwiki.objects.BaseCollection
addField, addPropertyForRemoval, apply, equals, get, getCurrentReferenceDocumentReferenceResolver, getCustomMappingMap, getDateValue, getDiff, getDoubleValue, getField, getFieldList, getFieldsToRemove, getFloatValue, getIntValue, getIntValue, getLargeStringValue, getListValue, getLongValue, getProperties, getPropertyList, getPropertyNames, getRelativeEntityReferenceResolver, getRelativeXClassReference, getSetValue, getSortedIterator, getStringValue, getXClassReference, merge, merge, mergeField, put, removeField, safeget, safeput, setClassName, setDateValue, setDBStringListValue, setDocumentReference, setDoubleValue, setFields, setFieldsToRemove, setFloatValue, setIntValue, setLargeStringValue, setLongValue, setOwnerDocument, setSetValue, setStringListValue, setStringValue, setXClassReference, toXMLString

Methods inherited from class com.xpn.xwiki.objects.BaseElement
fromXML, getDocumentReference, getLocalEntityReferenceSerializer, getLocalization, getLocalKey, getLocalUidStringEntityReferenceSerializer, getMergeManager, getOwnerDocument, getReference, getXWikiContext, hashCode, localizePlain, localizePlainOrKey, toString, toXMLString

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.xpn.xwiki.objects.ObjectInterface
get, put, safeget, safeput

Methods inherited from interface com.xpn.xwiki.objects.ElementInterface
apply, getDocumentReference, getReference, merge, setDocumentReference, toString

- Field Detail
  - DISPLAYTYPE_INPUT
```
public static final String DISPLAYTYPE_INPUT
```
    Since:
    
    6.2RC1
    
    See Also:
    
    Constant Field Values
  - DISPLAYTYPE_RADIO
```
public static final String DISPLAYTYPE_RADIO
```
    Since:
    
    6.2RC1
    
    See Also:
    
    Constant Field Values
  - DISPLAYTYPE_CHECKBOX
```
public static final String DISPLAYTYPE_CHECKBOX
```
    Since:
    
    6.2RC1
    
    See Also:
    
    Constant Field Values
  - DISPLAYTYPE_SELECT
```
public static final String DISPLAYTYPE_SELECT
```
    Since:
    
    6.2RC1
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SEPARATOR
```
public static final String DEFAULT_SEPARATOR
```
    Default separator/delimiter to use to split or join a list stored as a string. Not to be confused with getSeparator() and getSeparator() which are used only for UI view and edit operations.
    
    Since:
    
    7.0M2
    
    See Also:
    
    Constant Field Values
  - SEPARATOR_ESCAPE
```
public static final char SEPARATOR_ESCAPE
```
    Used to escape a separator character inside a string serialized list item.
    
    Since:
    
    7.0M2
    
    See Also:
    
    Constant Field Values
  - FREE_TEXT_DISCOURAGED
```
public static final String FREE_TEXT_DISCOURAGED
```
    Since:
    
    10.11RC1
    
    See Also:
    
    Constant Field Values
  - FREE_TEXT_FORBIDDEN
```
public static final String FREE_TEXT_FORBIDDEN
```
    Since:
    
    10.11RC1
    
    See Also:
    
    Constant Field Values
  - FREE_TEXT_ALLOWED
```
public static final String FREE_TEXT_ALLOWED
```
    Since:
    
    10.11RC1
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ListClass
```
public ListClass(String name,
                 String prettyname,
                 PropertyMetaClass wclass)
```
  - ListClass
```
public ListClass(PropertyMetaClass wclass)
```
  - ListClass
```
public ListClass()
```
- Method Detail
  - getSeparators
```
public String getSeparators()
```
    Returns:
    
    a string of separator characters used to split/deserialize an input string coming from the UI (filled by the user) that represents a serialized list
    
    See Also:
    
    displayEdit(StringBuffer, String, String, BaseCollection, XWikiContext), fromString(String)
  - setSeparators
```
public void setSeparators(String separators)
```
    Parameters:
    
    separators - a string of characters used to split/deserialize an input string coming from the UI (filled by the user) that represents a serialized list
  - getDisplayType
```
public String getDisplayType()
```
  - setDisplayType
```
public void setDisplayType(String type)
```
  - getSort
```
public String getSort()
```
  - setSort
```
public void setSort(String sort)
```
  - getSize
```
public int getSize()
```
  - setSize
```
public void setSize(int size)
```
  - isCache
```
public boolean isCache()
```
  - setCache
```
public void setCache(boolean cache)
```
  - isMultiSelect
```
public boolean isMultiSelect()
```
  - setMultiSelect
```
public void setMultiSelect(boolean multiSelect)
```
  - isRelationalStorage
```
public boolean isRelationalStorage()
```
  - setRelationalStorage
```
public void setRelationalStorage(boolean relationalStorage)
```
    Parameters:
    
    relationalStorage - if false, the list items will be concatenated into a VARCHAR column on a single row. Otherwise, items are stored in their own entries in the database. In most cases, this property should have the same value as the multiSelect property
  - isPicker
```
public boolean isPicker()
```
  - setPicker
```
public void setPicker(boolean picker)
```
  - isLargeStorage
```
public boolean isLargeStorage()
```
    Since:
    
    11.5RC1
  - setLargeStorage
```
public void setLargeStorage(boolean largeStorage)
```
    Since:
    
    11.5RC1
  - getSeparator
```
public String getSeparator()
```
    Returns:
    
    a string (usually just 1 character long) used to join this list's items when displaying it in the UI in view mode.
    
    See Also:
    
    displayView(StringBuffer, String, String, BaseCollection, XWikiContext)
  - setSeparator
```
public void setSeparator(String separator)
```
    Parameters:
    
    separator - a string (usually just 1 character long) used to join this list's items when displaying it in the UI in view mode.
  - getDefaultValue
```
public String getDefaultValue()
```
    Returns:
    
    the default value used in the select editor
    
    Since:
    
    10.9, 10.8.1
  - setDefaultValue
```
public void setDefaultValue(String separator)
```
    Parameters:
    
    separator - the default value used in the select editor
    
    Since:
    
    10.9, 10.8.1
  - getFreeText
```
public String getFreeText()
```
    Returns:
    
    the value of freeText (forbidden, discouraged or allowed)
    
    Since:
    
    10.11RC1
  - setFreeText
```
public void setFreeText(String type)
```
    Parameters:
    
    type - the value of freeText (forbidden, discouraged or allowed)
    
    Since:
    
    10.11RC1
  - getListFromString
```
public static List<String> getListFromString(String value)
```
    Convenience method, using "|" as separator and parsing key=value items.
    
    Parameters:
    
    value - the string holding a serialized list
    
    Returns:
    
    the list that was stored in the input string
    
    See Also:
    
    getListFromString(String, String, boolean)
  - getListFromString
```
public static List<String> getListFromString(String value,
                                             String separators,
                                             boolean withMap)
```
    Parameters:
    
    value - the string holding a serialized list
    
    separators - the separator characters (given as a string) used to delimit the list's items inside the input string. These separators can also be present, in escaped (92) form, inside list items
    
    withMap - set to true if the list's values contain map entries (key=value pairs) that should also be parsed. Only the keys are extracted from such list items
    
    Returns:
    
    the list that was stored in the input string
  - getStringFromList
```
public static String getStringFromList(List<String> list)
```
    Convenience method, using "|" as separator.
    
    Parameters:
    
    list - the list to serialize
    
    Returns:
    
    a string representing a serialized list, delimited by the first separator character (from the ones inside the separators string). Separators inside list items are safely escaped (92).
    
    See Also:
    
    getStringFromList(List, String)
  - getStringFromList
```
public static String getStringFromList(List<String> list,
                                       String separators)
```
    Parameters:
    
    list - the list to serialize
    
    separators - the separator characters (given as a string) used when the list was populated with values. The list's items can contain these separators in plain/unescaped form. The first separator character will be used to join the list in the output.
    
    Returns:
    
    a string representing a serialized list, delimited by the first separator character (from the ones inside the separators string). Separators inside list items are safely escaped (92).
  - getMapFromString
```
public static Map<String,ListItem> getMapFromString(String value)
```
  - toFormString
```
public String toFormString(BaseProperty property)
```
    Used in displayEdit(StringBuffer, String, String, BaseCollection, XWikiContext).
    
    Parameters:
    
    property - a property to be used in an form input
    
    Returns:
    
    the text value to be used in an form input. If a ListProperty is passed, the list's separators defined by getSeparators() are escaped for each list item and the items are joined by the first separator
    
    See Also:
    
    getStringFromList(List, String)
  - newProperty
```
public BaseProperty newProperty()
```
    Specified by:
    
    newProperty in interface PropertyClassInterface
    
    Overrides:
    
    newProperty in class PropertyClass
  - fromString
```
public BaseProperty fromString(String value)
```
    Specified by:
    
    fromString in interface PropertyClassInterface
    
    Overrides:
    
    fromString in class PropertyClass
  - fromStringArray
```
public BaseProperty fromStringArray(String[] strings)
```
    Overrides:
    
    fromStringArray in class PropertyClass
  - newPropertyfromXML
```
public BaseProperty newPropertyfromXML(org.dom4j.Element ppcel)
```
    Overrides:
    
    newPropertyfromXML in class PropertyClass
  - getDisplayValue
```
protected String getDisplayValue(String value,
                                 String name,
                                 Map<String,ListItem> map,
                                 XWikiContext context)
```
    Search for an internationalizable display text for the current value. The search process is:
    1. let V = the internal value of the option, used as the "value" attribute of the <option> element, and D = the displayed value
    2. if a message with the key <fieldFullName>_<V> exists, return it as D
    3. else, if a message with the key option_<fieldName>_<V> exists, return it as D
    4. else, if a message with the key option_<V> exists, return it as D
    5. else, D can be specified in the values parameter of the property by using V=D
    6. else return V
    Parameters:
    
    value - The internal value.
    
    name - The name of the ListProperty.
    
    map - The value=name mapping specified in the "values" parameter of the property.
    
    context - The request context.
    
    Returns:
    
    The text that should be displayed, representing a human-understandable name for the internal value.
  - getDisplayValue
```
protected String getDisplayValue(Object rawvalue,
                                 String name,
                                 Map<String,ListItem> map,
                                 XWikiContext context)
```
    Search for an internationalizable display text for the current value. The value can be either a simple string, or a value=name pair selected from the database.
    
    Parameters:
    
    rawvalue - The internal value, or a value=name pair.
    
    name - The name of the ListProperty.
    
    map - The value=name mapping specified in the "values" parameter of the property.
    
    context - The request context.
    
    Returns:
    
    The text that should be displayed, representing a human-understandable name for the internal value.
    
    See Also:
    
    getDisplayValue(String, String, Map, XWikiContext)
  - getElementValue
```
protected String getElementValue(Object rawvalue)
```
    If the list is populated with value=name pairs selected from the database, then return only the value. Otherwise, it is a simple value.
    
    Parameters:
    
    rawvalue -
    
    Returns:
    
    The list value
  - displayHidden
```
public void displayHidden(StringBuffer buffer,
                          String name,
                          String prefix,
                          BaseCollection object,
                          XWikiContext context)
```
    Specified by:
    
    displayHidden in interface PropertyClassInterface
    
    Overrides:
    
    displayHidden in class PropertyClass
  - displayView
```
public void displayView(StringBuffer buffer,
                        String name,
                        String prefix,
                        BaseCollection object,
                        XWikiContext context)
```
    Specified by:
    
    displayView in interface PropertyClassInterface
    
    Overrides:
    
    displayView in class PropertyClass
  - displayEdit
```
public void displayEdit(StringBuffer buffer,
                        String name,
                        String prefix,
                        BaseCollection object,
                        XWikiContext context)
```
    Specified by:
    
    displayEdit in interface PropertyClassInterface
    
    Overrides:
    
    displayEdit in class PropertyClass
  - displayRadioEdit
```
protected void displayRadioEdit(StringBuffer buffer,
                                String name,
                                String prefix,
                                BaseCollection object,
                                XWikiContext context)
```
  - displaySelectEdit
```
protected void displaySelectEdit(StringBuffer buffer,
                                 String name,
                                 String prefix,
                                 BaseCollection object,
                                 XWikiContext context)
```
  - getList
```
public abstract List<String> getList(XWikiContext context)
```
  - getMap
```
public abstract Map<String,ListItem> getMap(XWikiContext context)
```
  - toList
```
public List<String> toList(BaseProperty<?> property)
```
    ListClass does not produce only ListPropertys and this method allows to access the value as List whatever property is actually storing it.
    There is no guarantees the returned List will be modifiable.
    
    Parameters:
    
    property - the property created by this class
    
    Returns:
    
    the List representation of this property
    
    Since:
    
    6.2M1
  - fromList
```
public void fromList(BaseProperty<?> property,
                     List<String> list)
```
    Set the passed List into the passed property.
    
    Parameters:
    
    property - the property to modify
    
    list - the list to set
    
    Since:
    
    6.2M1
  - mergeProperty
```
public <T extends EntityReference> void mergeProperty(BaseProperty<T> currentProperty,
                                                      BaseProperty<T> previousProperty,
                                                      BaseProperty<T> newProperty,
                                                      MergeConfiguration configuration,
                                                      XWikiContext context,
                                                      MergeResult mergeResult)
```
    Description copied from class: PropertyClass
    
    Apply a 3 ways merge on passed current, previous and new version of the same property. The passed current version is modified as result of the merge.
    
    Overrides:
    
    mergeProperty in class PropertyClass
    
    Parameters:
    
    currentProperty - the current version of the element and the one to modify
    
    previousProperty - the previous version of the element
    
    newProperty - the new version of the property
    
    configuration - the configuration of the merge Indicate how to deal with some conflicts use cases, etc.
    
    context - the XWiki context
    
    mergeResult - the merge report
  - mergeNotOrderedListProperty
```
protected <T extends EntityReference> void mergeNotOrderedListProperty(BaseProperty<T> currentProperty,
                                                                       BaseProperty<T> previousProperty,
                                                                       BaseProperty<T> newProperty,
                                                                       MergeConfiguration configuration,
                                                                       XWikiContext context,
                                                                       MergeResult mergeResult)
```

Class ListClass

Nested Class Summary

Field Summary

Fields inherited from class com.xpn.xwiki.objects.classes.PropertyClass

Fields inherited from class com.xpn.xwiki.objects.BaseCollection

Fields inherited from class com.xpn.xwiki.objects.BaseElement

Constructor Summary

Method Summary

Methods inherited from class com.xpn.xwiki.objects.classes.PropertyClass

Methods inherited from class com.xpn.xwiki.objects.BaseCollection

Methods inherited from class com.xpn.xwiki.objects.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface com.xpn.xwiki.objects.ObjectInterface

Methods inherited from interface com.xpn.xwiki.objects.ElementInterface

Field Detail

DISPLAYTYPE_INPUT

DISPLAYTYPE_RADIO

DISPLAYTYPE_CHECKBOX

DISPLAYTYPE_SELECT

DEFAULT_SEPARATOR

SEPARATOR_ESCAPE

FREE_TEXT_DISCOURAGED

FREE_TEXT_FORBIDDEN

FREE_TEXT_ALLOWED

Constructor Detail

ListClass

ListClass

ListClass

Method Detail

getSeparators

setSeparators

getDisplayType

setDisplayType

getSort

setSort

getSize

setSize

isCache

setCache

isMultiSelect

setMultiSelect

isRelationalStorage

setRelationalStorage

isPicker

setPicker

isLargeStorage

setLargeStorage

getSeparator

setSeparator

getDefaultValue

setDefaultValue

getFreeText

setFreeText

getListFromString

getListFromString

getStringFromList

getStringFromList

getMapFromString

toFormString

newProperty

fromString

fromStringArray

newPropertyfromXML

getDisplayValue

getDisplayValue

getElementValue

displayHidden

displayView

displayEdit

displayRadioEdit

displaySelectEdit

getList

getMap

toList

fromList

mergeProperty

mergeNotOrderedListProperty