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

Modifier and Type	Method	Description
void	displayEdit(StringBuffer buffer, String name, String prefix, BaseCollection object, XWikiContext context)
void	displayView(StringBuffer buffer, String name, String prefix, BaseCollection object, boolean isolated, XWikiContext context)
void	displayView(StringBuffer buffer, String name, String prefix, BaseCollection object, XWikiContext context)
String	getContentType()
static TextAreaClass.ContentType	getContentType(TextAreaClass.EditorType editorType, TextAreaClass.ContentType def)
String	getEditor()
static TextAreaClass.EditorType	getEditorType(TextAreaClass.ContentType contentType, TextAreaClass.EditorType def)
static TextAreaClass.EditorType	getEditorType(String contentType, TextAreaClass.EditorType def)
int	getRows()
boolean	isRestricted()	Indicate if the content of this property should be executed in a restricted content (provided the type indicate that this content should be executed).
boolean	isWikiContent()
boolean	isWysiwyg(XWikiContext context)
BaseProperty	newProperty()
void	setContentType(TextAreaClass.ContentType contentType)
void	setContentType(String contentType)
void	setEditor(TextAreaClass.EditorType editorType)	Sets the editor meta property.
void	setEditor(String editor)	Sets the editor meta property.
void	setRestricted(boolean restricted)	Indicate if the content of this property should be executed in a restricted content (provided the type indicate that this content should be executed).
void	setRows(int rows)

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, 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

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 value

def - 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 interface PropertyClassInterface

Overrides:

newProperty in class StringClass

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

isRestricted

@Unstable
public boolean isRestricted()

Indicate if the content of this property should be executed in a restricted content (provided the type indicate that this content should be executed).

Returns:

true if the content of this property should be executed in a restricted content, false otherwise

Since:

14.10, 14.4.7, 13.10.11

setRestricted

@Unstable
public void setRestricted(boolean restricted)

Indicate if the content of this property should be executed in a restricted content (provided the type indicate that this content should be executed).

Parameters:

restricted - true if the content of this property should be executed in a restricted content, false otherwise

Since:

14.10, 14.4.7, 13.10.11

displayEdit

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

Specified by:

displayEdit in interface PropertyClassInterface

Overrides:

displayEdit in class StringClass

displayView

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

Specified by:

displayView in interface PropertyClassInterface

Overrides:

displayView in class StringClass

displayView

public void displayView(StringBuffer buffer,
                        String name,
                        String prefix,
                        BaseCollection object,
                        boolean isolated,
                        XWikiContext context)