org.odftoolkit.odfdom.dom.element.form

Class FormFrameElement

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.FormFrameElement

All Implemented Interfaces:

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

public class FormFrameElement
extends OdfElement

DOM implementation of OpenDocument element form:frame.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and 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 and Description
FormFrameElement(OdfFileDom ownerDoc) Create the instance of FormFrameElement

Method Summary

Modifier and Type	Method and 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	getFormDisabledAttribute() Receives the value of the ODFDOM attribute representation FormDisabledAttribute , See form:disabled
String	getFormForAttribute() Receives the value of the ODFDOM attribute representation FormForAttribute , See form:for
String	getFormIdAttribute() Receives the value of the ODFDOM attribute representation FormIdAttribute , See form:id
String	getFormLabelAttribute() Receives the value of the ODFDOM attribute representation FormLabelAttribute , See form:label
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
String	getFormTitleAttribute() Receives the value of the ODFDOM attribute representation FormTitleAttribute , See form:title
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	setFormDisabledAttribute(Boolean formDisabledValue) Sets the value of ODFDOM attribute representation FormDisabledAttribute , See form:disabled
void	setFormForAttribute(String formForValue) Sets the value of ODFDOM attribute representation FormForAttribute , See form:for
void	setFormIdAttribute(String formIdValue) Sets the value of ODFDOM attribute representation FormIdAttribute , See form:id
void	setFormLabelAttribute(String formLabelValue) Sets the value of ODFDOM attribute representation FormLabelAttribute , See form:label
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	setFormTitleAttribute(String formTitleValue) Sets the value of ODFDOM attribute representation FormTitleAttribute , See form:title
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

cloneNode, cloneOdfElement, equals, findFirstChildNode, findNextChildNode, findPreviousChildNode, getAncestorAs, getOdfAttribute, getOdfAttribute, getOdfAttributeValue, getParentAs, hasOdfAttribute, insertBefore, onInsertNode, onInsertNode, onRemoveNode, onRemoveNode, removeChild, replaceChild, setOdfAttribute, setOdfAttributeValue, 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, getTextContent, 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, appendChild, 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

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

Field Detail

ELEMENT_NAME

public static final OdfName ELEMENT_NAME

Constructor Detail

FormFrameElement

public FormFrameElement(OdfFileDom ownerDoc)

Create the instance of FormFrameElement

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:frame.

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

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

getFormForAttribute

public String getFormForAttribute()

Receives the value of the ODFDOM attribute representation FormForAttribute , See form:for

Returns:

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

setFormForAttribute

public void setFormForAttribute(String formForValue)

Sets the value of ODFDOM attribute representation FormForAttribute , See form:for

Parameters:

formForValue - The type is String

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

getFormLabelAttribute

public String getFormLabelAttribute()

Receives the value of the ODFDOM attribute representation FormLabelAttribute , See form:label

Returns:

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

setFormLabelAttribute

public void setFormLabelAttribute(String formLabelValue)

Sets the value of ODFDOM attribute representation FormLabelAttribute , See form:label

Parameters:

formLabelValue - The type is String

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

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

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