Package com.xpn.xwiki.objects.classes
Class TextAreaClass
- 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.StringClass
-
- com.xpn.xwiki.objects.classes.TextAreaClass
-
- All Implemented Interfaces:
PropertyClassInterface
,ElementInterface
,ObjectInterface
,PropertyInterface
,Serializable
,Cloneable
,Comparable<PropertyClass>
public class TextAreaClass extends StringClass
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
TextAreaClass.ContentType
Possible values for the contenttype meta property.static class
TextAreaClass.EditorType
Possible values for the editor meta property.
-
Field Summary
-
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 TextAreaClass()
TextAreaClass(PropertyMetaClass wclass)
-
Method Summary
-
Methods inherited from class com.xpn.xwiki.objects.classes.StringClass
fromString, getSize, isPicker, setPicker, setSize
-
Methods inherited from class com.xpn.xwiki.objects.classes.PropertyClass
clone, compareTo, createReference, displayCustom, displayEdit, displayEdit, displayHidden, displayHidden, displayHidden, displayView, displayView, flushCache, fromStringArray, 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, mergeProperty, newPropertyfromXML, 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.ElementInterface
apply, getDocumentReference, getReference, merge, setDocumentReference, toString
-
Methods inherited from interface com.xpn.xwiki.objects.ObjectInterface
get, put, safeget, safeput
-
-
-
-
Constructor Detail
-
TextAreaClass
public TextAreaClass(PropertyMetaClass wclass)
-
TextAreaClass
public TextAreaClass()
-
-
Method Detail
-
getEditorType
public static TextAreaClass.EditorType getEditorType(TextAreaClass.ContentType contentType, TextAreaClass.EditorType def)
- Parameters:
contentType
- the content type- Returns:
- the editor type compatible with the passed content type, null if several are compatible
-
getEditorType
public static TextAreaClass.EditorType getEditorType(String contentType, TextAreaClass.EditorType def)
- Parameters:
contentType
- the content type valuedef
- the current editor type- Returns:
- the editor type compatible with the passed content type, def if several are compatible
- Since:
- 10.7RC1
-
getContentType
public static TextAreaClass.ContentType getContentType(TextAreaClass.EditorType editorType, TextAreaClass.ContentType def)
- Parameters:
editorType
- the editor type- Returns:
- the content type compatible with the passed editor type, null if several are compatible
-
newProperty
public BaseProperty newProperty()
- Specified by:
newProperty
in interfacePropertyClassInterface
- Overrides:
newProperty
in classStringClass
-
getRows
public int getRows()
-
setRows
public void setRows(int rows)
-
getEditor
public String getEditor()
-
setEditor
public void setEditor(String editor)
Sets the editor meta property.- Parameters:
editor
- the editor type- Since:
- 8.2RC1
-
setEditor
public void setEditor(TextAreaClass.EditorType editorType)
Sets the editor meta property.- Parameters:
editorType
- the editor type- Since:
- 8.3
-
getContentType
public String getContentType()
-
setContentType
public void setContentType(String contentType)
-
setContentType
public void setContentType(TextAreaClass.ContentType contentType)
- Parameters:
contentType
- the content type- Since:
- 8.3
-
isWysiwyg
public boolean isWysiwyg(XWikiContext context)
-
isWikiContent
public boolean isWikiContent()
- Returns:
- true if the content of this text area is not a wiki syntax content
-
displayEdit
public void displayEdit(StringBuffer buffer, String name, String prefix, BaseCollection object, XWikiContext context)
- Specified by:
displayEdit
in interfacePropertyClassInterface
- Overrides:
displayEdit
in classStringClass
-
displayView
public void displayView(StringBuffer buffer, String name, String prefix, BaseCollection object, XWikiContext context)
- Specified by:
displayView
in interfacePropertyClassInterface
- Overrides:
displayView
in classStringClass
-
displayView
public void displayView(StringBuffer buffer, String name, String prefix, BaseCollection object, boolean isolated, XWikiContext context)
-
-