Package com.xpn.xwiki.objects.classes

Class LevelsClass

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

com.xpn.xwiki.objects.classes.LevelsClass

All Implemented Interfaces:

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

public class LevelsClass
extends ListClass

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.xpn.xwiki.objects.classes.ListClass

ListClass.MapComparator

Field Summary

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

DEFAULT_SEPARATOR, DISPLAYTYPE_CHECKBOX, DISPLAYTYPE_INPUT, DISPLAYTYPE_RADIO, DISPLAYTYPE_SELECT, FREE_TEXT_ALLOWED, FREE_TEXT_DISCOURAGED, FREE_TEXT_FORBIDDEN, SEPARATOR_ESCAPE

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	Description
LevelsClass()
LevelsClass(PropertyMetaClass wclass)

Method Summary

Modifier and Type	Method	Description
void	displayEdit(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)
protected String	getFirstSeparator()
List<String>	getList(XWikiContext context)
static List<String>	getListFromString(String value)
Map<String,ListItem>	getMap(XWikiContext context)
String	getText(String value, XWikiContext context)
<T extends EntityReference> void	mergeProperty(BaseProperty<T> currentProperty, BaseProperty<T> previousProperty, BaseProperty<T> newProperty, MergeConfiguration configuration, XWikiContext xcontext, 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)
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.

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

displayHidden, displayRadioEdit, displaySelectEdit, displayView, fromList, getDefaultValue, getDisplayType, getDisplayValue, getDisplayValue, getElementValue, getFreeText, getListFromString, getListFromString, getMapFromString, getSeparator, getSeparators, getSize, getSort, getStringFromList, getStringFromList, isCache, isLargeStorage, isMultiSelect, isPicker, isRelationalStorage, mergeNotOrderedListProperty, setCache, setDefaultValue, setDisplayType, setFreeText, setLargeStorage, setMultiSelect, setPicker, setRelationalStorage, setSeparator, setSeparators, setSize, setSort, toFormString

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, merge, toString, toXMLString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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

apply, getDocumentReference, getReference, merge, merge, setDocumentReference, toString

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

get, put, safeget, safeput

Methods inherited from interface com.xpn.xwiki.objects.classes.PropertyClassInterface

displayView

Constructor Detail

LevelsClass

public LevelsClass(PropertyMetaClass wclass)

LevelsClass

public LevelsClass()

Method Detail

getFirstSeparator

protected String getFirstSeparator()

Overrides:

getFirstSeparator in class ListClass

Returns:

the first separator of the list of separators, or fallback on ListClass.DEFAULT_SEPARATOR.

getList

public List<String> getList(XWikiContext context)

Specified by:

getList in class ListClass

getMap

public Map<String,ListItem> getMap(XWikiContext context)

Specified by:

getMap in class ListClass

newProperty

public BaseProperty newProperty()

Specified by:

newProperty in interface PropertyClassInterface

Overrides:

newProperty in class ListClass

fromString

public BaseProperty fromString(String value)

Specified by:

fromString in interface PropertyClassInterface

Overrides:

fromString in class ListClass

fromStringArray

public BaseProperty fromStringArray(String[] strings)

Overrides:

fromStringArray in class ListClass

fromList

public void fromList(BaseProperty<?> property,
                     List<String> list)

Description copied from class: ListClass

Set the passed List into the passed property.

Overrides:

fromList in class ListClass

Parameters:

property - the property to modify

list - the list to set

getText

public String getText(String value,
                      XWikiContext context)

getListFromString

public static List<String> getListFromString(String value)

displayEdit

public void displayEdit(StringBuffer buffer,
                        String name,
                        String prefix,
                        BaseCollection object,
                        XWikiContext context)

Specified by:

displayEdit in interface PropertyClassInterface

Overrides:

displayEdit in class ListClass

newPropertyfromXML

public BaseProperty newPropertyfromXML(org.dom4j.Element ppcel)

Overrides:

newPropertyfromXML in class ListClass

toList

public List<String> toList(BaseProperty<?> property)

Description copied from class: ListClass

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.

Overrides:

toList in class ListClass

Parameters:

property - the property created by this class

Returns:

the List representation of this property

mergeProperty

public <T extends EntityReference> void mergeProperty(BaseProperty<T> currentProperty,
                                                      BaseProperty<T> previousProperty,
                                                      BaseProperty<T> newProperty,
                                                      MergeConfiguration configuration,
                                                      XWikiContext xcontext,
                                                      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 ListClass

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.

xcontext - the XWiki context

mergeResult - the merge report