Package org.odftoolkit.odfdom.dom.element.form

Class FormTextElement

java.lang.Object

org.apache.xerces.dom.NodeImpl

org.apache.xerces.dom.ChildNode

org.apache.xerces.dom.ParentNode

org.apache.xerces.dom.ElementImpl

org.apache.xerces.dom.ElementNSImpl

org.odftoolkit.odfdom.pkg.OdfElement

org.odftoolkit.odfdom.dom.element.form.FormTextElement

All Implemented Interfaces:

Serializable, Cloneable, Element, ElementTraversal, EventTarget, Node, NodeList, TypeInfo

public class FormTextElement
extends OdfElement

DOM implementation of OpenDocument element <form:text>.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static OdfName	ELEMENT_NAME

Fields inherited from class org.apache.xerces.dom.ElementNSImpl

localName, namespaceURI

Fields inherited from class org.apache.xerces.dom.ElementImpl

attributes, name

Fields inherited from class org.apache.xerces.dom.ParentNode

firstChild, fNodeListCache, ownerDocument

Fields inherited from class org.apache.xerces.dom.ChildNode

nextSibling, previousSibling

Fields inherited from class org.apache.xerces.dom.NodeImpl

DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_IS_CONTAINED, DOCUMENT_POSITION_PRECEDING, ELEMENT_DEFINITION_NODE, FIRSTCHILD, flags, HASSTRING, ID, IGNORABLEWS, NORMALIZED, OWNED, ownerNode, READONLY, SPECIFIED, SYNCCHILDREN, SYNCDATA, TREE_POSITION_ANCESTOR, TREE_POSITION_DESCENDANT, TREE_POSITION_DISCONNECTED, TREE_POSITION_EQUIVALENT, TREE_POSITION_FOLLOWING, TREE_POSITION_PRECEDING, TREE_POSITION_SAME_NODE

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Fields inherited from interface org.w3c.dom.TypeInfo

DERIVATION_EXTENSION, DERIVATION_LIST, DERIVATION_RESTRICTION, DERIVATION_UNION

Constructor Summary

Constructors

Constructor	Description
FormTextElement(OdfFileDom ownerDoc)	Create the instance of FormTextElement

Method Summary

Modifier and Type	Method	Description
void	accept(ElementVisitor visitor)	Accept an visitor instance to allow the visitor to do some operations.
String	getFormControlImplementationAttribute()	Receives the value of the ODFDOM attribute representation FormControlImplementationAttribute , See @form:control-implementation
Boolean	getFormConvertEmptyToNullAttribute()	Receives the value of the ODFDOM attribute representation FormConvertEmptyToNullAttribute , See @form:convert-empty-to-null
String	getFormCurrentValueAttribute()	Receives the value of the ODFDOM attribute representation FormCurrentValueAttribute , See @form:current-value
String	getFormDataFieldAttribute()	Receives the value of the ODFDOM attribute representation FormDataFieldAttribute , See @form:data-field
Boolean	getFormDisabledAttribute()	Receives the value of the ODFDOM attribute representation FormDisabledAttribute , See @form:disabled
String	getFormIdAttribute()	Receives the value of the ODFDOM attribute representation FormIdAttribute , See @form:id
String	getFormLinkedCellAttribute()	Receives the value of the ODFDOM attribute representation FormLinkedCellAttribute , See @form:linked-cell
Integer	getFormMaxLengthAttribute()	Receives the value of the ODFDOM attribute representation FormMaxLengthAttribute , See @form:max-length
String	getFormNameAttribute()	Receives the value of the ODFDOM attribute representation FormNameAttribute , See @form:name
Boolean	getFormPrintableAttribute()	Receives the value of the ODFDOM attribute representation FormPrintableAttribute , See @form:printable
Boolean	getFormReadonlyAttribute()	Receives the value of the ODFDOM attribute representation FormReadonlyAttribute , See @form:readonly
Integer	getFormTabIndexAttribute()	Receives the value of the ODFDOM attribute representation FormTabIndexAttribute , See @form:tab-index
Boolean	getFormTabStopAttribute()	Receives the value of the ODFDOM attribute representation FormTabStopAttribute , See @form:tab-stop
String	getFormTitleAttribute()	Receives the value of the ODFDOM attribute representation FormTitleAttribute , See @form:title
String	getFormValueAttribute()	Receives the value of the ODFDOM attribute representation FormValueAttribute , See @form:value
OdfName	getOdfName()	Get the element name
String	getXformsBindAttribute()	Receives the value of the ODFDOM attribute representation XformsBindAttribute , See @xforms:bind
String	getXmlIdAttribute()	Receives the value of the ODFDOM attribute representation XmlIdAttribute , See @xml:id
FormPropertiesElement	newFormPropertiesElement()	Create child element <form:properties>.
OfficeEventListenersElement	newOfficeEventListenersElement()	Create child element <office:event-listeners>.
void	setFormControlImplementationAttribute(String formControlImplementationValue)	Sets the value of ODFDOM attribute representation FormControlImplementationAttribute , See @form:control-implementation
void	setFormConvertEmptyToNullAttribute(Boolean formConvertEmptyToNullValue)	Sets the value of ODFDOM attribute representation FormConvertEmptyToNullAttribute , See @form:convert-empty-to-null
void	setFormCurrentValueAttribute(String formCurrentValueValue)	Sets the value of ODFDOM attribute representation FormCurrentValueAttribute , See @form:current-value
void	setFormDataFieldAttribute(String formDataFieldValue)	Sets the value of ODFDOM attribute representation FormDataFieldAttribute , See @form:data-field
void	setFormDisabledAttribute(Boolean formDisabledValue)	Sets the value of ODFDOM attribute representation FormDisabledAttribute , See @form:disabled
void	setFormIdAttribute(String formIdValue)	Sets the value of ODFDOM attribute representation FormIdAttribute , See @form:id
void	setFormLinkedCellAttribute(String formLinkedCellValue)	Sets the value of ODFDOM attribute representation FormLinkedCellAttribute , See @form:linked-cell
void	setFormMaxLengthAttribute(Integer formMaxLengthValue)	Sets the value of ODFDOM attribute representation FormMaxLengthAttribute , See @form:max-length
void	setFormNameAttribute(String formNameValue)	Sets the value of ODFDOM attribute representation FormNameAttribute , See @form:name
void	setFormPrintableAttribute(Boolean formPrintableValue)	Sets the value of ODFDOM attribute representation FormPrintableAttribute , See @form:printable
void	setFormReadonlyAttribute(Boolean formReadonlyValue)	Sets the value of ODFDOM attribute representation FormReadonlyAttribute , See @form:readonly
void	setFormTabIndexAttribute(Integer formTabIndexValue)	Sets the value of ODFDOM attribute representation FormTabIndexAttribute , See @form:tab-index
void	setFormTabStopAttribute(Boolean formTabStopValue)	Sets the value of ODFDOM attribute representation FormTabStopAttribute , See @form:tab-stop
void	setFormTitleAttribute(String formTitleValue)	Sets the value of ODFDOM attribute representation FormTitleAttribute , See @form:title
void	setFormValueAttribute(String formValueValue)	Sets the value of ODFDOM attribute representation FormValueAttribute , See @form:value
void	setXformsBindAttribute(String xformsBindValue)	Sets the value of ODFDOM attribute representation XformsBindAttribute , See @xforms:bind
void	setXmlIdAttribute(String xmlIdValue)	Sets the value of ODFDOM attribute representation XmlIdAttribute , See @xml:id

Methods inherited from class org.odftoolkit.odfdom.pkg.OdfElement

appendChild, appendUsingWhitespaceHandling, cloneElement, cloneNode, cloneNode, cloneNode, cloneOdfElement, componentSize, copyAttributes, countChildComponents, countDescendantComponents, countPrecedingSiblingElements, delete, equals, findFirstChildNode, findNextChildNode, findPreviousChildNode, getAncestorAs, getChildElement, getChildElement, getComponent, getComponentRoot, getFirstChildElement, getLastChildElement, getNextSiblingElement, getOdfAttribute, getOdfAttribute, getOdfAttributeValue, getParentAs, getPreviousSiblingElement, getRepetition, getTextContent, hasAncestor, hasOdfAttribute, ignoredComponent, insert, insert, insertBefore, isComponentRoot, isIgnoredElement, isIgnoredElement, isRepeatable, markAsComponentRoot, markText, moveChildrenTo, onInsertNode, onInsertNode, onRemoveNode, onRemoveNode, receiveNode, removeChild, removeContent, removeSingleElement, replaceChild, selfAndDescendantTextIgnoredAsComponent, setComponent, setOdfAttribute, setOdfAttributeValue, setRepetition, split, toString

Methods inherited from class org.apache.xerces.dom.ElementNSImpl

getLocalName, getNamespaceURI, getPrefix, getTypeName, getTypeNamespace, getXMLBaseAttribute, isDerivedFrom, setPrefix, setType

Methods inherited from class org.apache.xerces.dom.ElementImpl

getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getBaseURI, getChildElementCount, getDefaultAttributes, getElementsByTagName, getElementsByTagNameNS, getFirstElementChild, getLastElementChild, getNextElementSibling, getNodeName, getNodeType, getPreviousElementSibling, getSchemaTypeInfo, getTagName, getXercesAttribute, hasAttribute, hasAttributeNS, hasAttributes, isEqualNode, normalize, reconcileDefaultAttributes, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setOwnerDocument, setReadOnly, setupDefaultAttributes, setXercesAttributeNode, synchronizeData

Methods inherited from class org.apache.xerces.dom.ParentNode

getChildNodes, getChildNodesUnoptimized, getFirstChild, getLastChild, getLength, getOwnerDocument, hasChildNodes, item, setTextContent, synchronizeChildren

Methods inherited from class org.apache.xerces.dom.ChildNode

getNextSibling, getParentNode, getPreviousSibling

Methods inherited from class org.apache.xerces.dom.NodeImpl

addEventListener, changed, changes, compareDocumentPosition, compareTreePosition, dispatchEvent, getContainer, getFeature, getNodeNumber, getNodeValue, getReadOnly, getUserData, getUserData, getUserDataRecord, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, needsSyncChildren, removeEventListener, setNodeValue, setUserData, setUserData

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.w3c.dom.Node

compareDocumentPosition, getChildNodes, getFeature, getFirstChild, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, getUserData, hasChildNodes, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, setNodeValue, setTextContent, setUserData

Field Detail

ELEMENT_NAME

public static final OdfName ELEMENT_NAME

Constructor Detail

FormTextElement

public FormTextElement(OdfFileDom ownerDoc)

Create the instance of FormTextElement

Parameters:

ownerDoc - The type is OdfFileDom

Method Detail

getOdfName

public OdfName getOdfName()

Get the element name

Specified by:

getOdfName in class OdfElement

Returns:

return OdfName the name of element <form:text>.

getFormControlImplementationAttribute

public String getFormControlImplementationAttribute()

Receives the value of the ODFDOM attribute representation FormControlImplementationAttribute , See @form:control-implementation

Returns:

- the String , the value or null, if the attribute is not set and no default value defined.

setFormControlImplementationAttribute

public void setFormControlImplementationAttribute(String formControlImplementationValue)

Sets the value of ODFDOM attribute representation FormControlImplementationAttribute , See @form:control-implementation

Parameters:

formControlImplementationValue - The type is String

getFormConvertEmptyToNullAttribute

public Boolean getFormConvertEmptyToNullAttribute()

Receives the value of the ODFDOM attribute representation FormConvertEmptyToNullAttribute , See @form:convert-empty-to-null

Returns:

- the Boolean , the value or null, if the attribute is not set and no default value defined.

setFormConvertEmptyToNullAttribute

public void setFormConvertEmptyToNullAttribute(Boolean formConvertEmptyToNullValue)

Sets the value of ODFDOM attribute representation FormConvertEmptyToNullAttribute , See @form:convert-empty-to-null

Parameters:

formConvertEmptyToNullValue - The type is Boolean

getFormCurrentValueAttribute

public String getFormCurrentValueAttribute()

Receives the value of the ODFDOM attribute representation FormCurrentValueAttribute , See @form:current-value

Returns:

- the String , the value or null, if the attribute is not set and no default value defined.

setFormCurrentValueAttribute

public void setFormCurrentValueAttribute(String formCurrentValueValue)

Sets the value of ODFDOM attribute representation FormCurrentValueAttribute , See @form:current-value

Parameters:

formCurrentValueValue - The type is String

getFormDataFieldAttribute

public String getFormDataFieldAttribute()

Receives the value of the ODFDOM attribute representation FormDataFieldAttribute , See @form:data-field

Returns:

- the String , the value or null, if the attribute is not set and no default value defined.

setFormDataFieldAttribute

public void setFormDataFieldAttribute(String formDataFieldValue)

Sets the value of ODFDOM attribute representation FormDataFieldAttribute , See @form:data-field

Parameters:

formDataFieldValue - The type is String

getFormDisabledAttribute

public Boolean getFormDisabledAttribute()

Receives the value of the ODFDOM attribute representation FormDisabledAttribute , See @form:disabled

Returns:

- the Boolean , the value or null, if the attribute is not set and no default value defined.

setFormDisabledAttribute

public void setFormDisabledAttribute(Boolean formDisabledValue)

Sets the value of ODFDOM attribute representation FormDisabledAttribute , See @form:disabled

Parameters:

formDisabledValue - The type is Boolean

getFormIdAttribute

public String getFormIdAttribute()

Receives the value of the ODFDOM attribute representation FormIdAttribute , See @form:id

Returns:

- the String , the value or null, if the attribute is not set and no default value defined.

setFormIdAttribute

public void setFormIdAttribute(String formIdValue)

Sets the value of ODFDOM attribute representation FormIdAttribute , See @form:id

Parameters:

formIdValue - The type is String

getFormLinkedCellAttribute

public String getFormLinkedCellAttribute()

Receives the value of the ODFDOM attribute representation FormLinkedCellAttribute , See @form:linked-cell

Returns:

- the String , the value or null, if the attribute is not set and no default value defined.

setFormLinkedCellAttribute

public void setFormLinkedCellAttribute(String formLinkedCellValue)

Sets the value of ODFDOM attribute representation FormLinkedCellAttribute , See @form:linked-cell

Parameters:

formLinkedCellValue - The type is String

getFormMaxLengthAttribute

public Integer getFormMaxLengthAttribute()

Receives the value of the ODFDOM attribute representation FormMaxLengthAttribute , See @form:max-length

Returns:

- the Integer , the value or null, if the attribute is not set and no default value defined.

setFormMaxLengthAttribute

public void setFormMaxLengthAttribute(Integer formMaxLengthValue)

Sets the value of ODFDOM attribute representation FormMaxLengthAttribute , See @form:max-length

Parameters:

formMaxLengthValue - The type is Integer

getFormNameAttribute

public String getFormNameAttribute()

Receives the value of the ODFDOM attribute representation FormNameAttribute , See @form:name

Returns:

- the String , the value or null, if the attribute is not set and no default value defined.

setFormNameAttribute

public void setFormNameAttribute(String formNameValue)

Sets the value of ODFDOM attribute representation FormNameAttribute , See @form:name

Parameters:

formNameValue - The type is String

getFormPrintableAttribute

public Boolean getFormPrintableAttribute()

Receives the value of the ODFDOM attribute representation FormPrintableAttribute , See @form:printable

Returns:

- the Boolean , the value or null, if the attribute is not set and no default value defined.

setFormPrintableAttribute

public void setFormPrintableAttribute(Boolean formPrintableValue)

Sets the value of ODFDOM attribute representation FormPrintableAttribute , See @form:printable

Parameters:

formPrintableValue - The type is Boolean

getFormReadonlyAttribute

public Boolean getFormReadonlyAttribute()

Receives the value of the ODFDOM attribute representation FormReadonlyAttribute , See @form:readonly

Returns:

- the Boolean , the value or null, if the attribute is not set and no default value defined.

setFormReadonlyAttribute

public void setFormReadonlyAttribute(Boolean formReadonlyValue)

Sets the value of ODFDOM attribute representation FormReadonlyAttribute , See @form:readonly

Parameters:

formReadonlyValue - The type is Boolean

getFormTabIndexAttribute

public Integer getFormTabIndexAttribute()

Receives the value of the ODFDOM attribute representation FormTabIndexAttribute , See @form:tab-index

Returns:

- the Integer , the value or null, if the attribute is not set and no default value defined.

setFormTabIndexAttribute

public void setFormTabIndexAttribute(Integer formTabIndexValue)

Sets the value of ODFDOM attribute representation FormTabIndexAttribute , See @form:tab-index

Parameters:

formTabIndexValue - The type is Integer

getFormTabStopAttribute

public Boolean getFormTabStopAttribute()

Receives the value of the ODFDOM attribute representation FormTabStopAttribute , See @form:tab-stop

Returns:

- the Boolean , the value or null, if the attribute is not set and no default value defined.

setFormTabStopAttribute

public void setFormTabStopAttribute(Boolean formTabStopValue)

Sets the value of ODFDOM attribute representation FormTabStopAttribute , See @form:tab-stop

Parameters:

formTabStopValue - The type is Boolean

getFormTitleAttribute

public String getFormTitleAttribute()

Receives the value of the ODFDOM attribute representation FormTitleAttribute , See @form:title

Returns:

- the String , the value or null, if the attribute is not set and no default value defined.

setFormTitleAttribute

public void setFormTitleAttribute(String formTitleValue)

Sets the value of ODFDOM attribute representation FormTitleAttribute , See @form:title

Parameters:

formTitleValue - The type is String

getFormValueAttribute

public String getFormValueAttribute()

Receives the value of the ODFDOM attribute representation FormValueAttribute , See @form:value

Returns:

- the String , the value or null, if the attribute is not set and no default value defined.

setFormValueAttribute

public void setFormValueAttribute(String formValueValue)

Sets the value of ODFDOM attribute representation FormValueAttribute , See @form:value

Parameters:

formValueValue - The type is String

getXformsBindAttribute

public String getXformsBindAttribute()

Receives the value of the ODFDOM attribute representation XformsBindAttribute , See @xforms:bind

Returns:

- the String , the value or null, if the attribute is not set and no default value defined.

setXformsBindAttribute

public void setXformsBindAttribute(String xformsBindValue)

Sets the value of ODFDOM attribute representation XformsBindAttribute , See @xforms:bind

Parameters:

xformsBindValue - The type is String

getXmlIdAttribute

public String getXmlIdAttribute()

Receives the value of the ODFDOM attribute representation XmlIdAttribute , See @xml:id

Attribute is mandatory.

Returns:

- the String , the value or null, if the attribute is not set and no default value defined.

setXmlIdAttribute

public void setXmlIdAttribute(String xmlIdValue)

Sets the value of ODFDOM attribute representation XmlIdAttribute , See @xml:id

Parameters:

xmlIdValue - The type is String

newFormPropertiesElement

public FormPropertiesElement newFormPropertiesElement()

Create child element <form:properties>.

Returns:

the element <form:properties>

newOfficeEventListenersElement

public OfficeEventListenersElement newOfficeEventListenersElement()

Create child element <office:event-listeners>.

Returns:

the element <office:event-listeners>

accept

public void accept(ElementVisitor visitor)

Description copied from class: OdfElement

Accept an visitor instance to allow the visitor to do some operations. Refer to visitor design pattern to get a better understanding.

Overrides:

accept in class OdfElement

Parameters:

visitor - an instance of DefaultElementVisitor