org.odftoolkit.odfdom.dom.element.style
Class StylePageLayoutElement

java.lang.Object
  extended by org.apache.xerces.dom.NodeImpl
      extended by org.apache.xerces.dom.ChildNode
          extended by org.apache.xerces.dom.ParentNode
              extended by org.apache.xerces.dom.ElementImpl
                  extended by org.apache.xerces.dom.ElementNSImpl
                      extended by org.odftoolkit.odfdom.pkg.OdfElement
                          extended by org.odftoolkit.odfdom.pkg.OdfContainerElementBase
                              extended by org.odftoolkit.odfdom.dom.element.OdfStyleBase
                                  extended by org.odftoolkit.odfdom.dom.element.style.StylePageLayoutElement
All Implemented Interfaces:
Serializable, Cloneable, Comparable, OdfStylePropertySet, Element, EventTarget, Node, NodeList, TypeInfo
Direct Known Subclasses:
OdfStylePageLayout

public class StylePageLayoutElement
extends OdfStyleBase

DOM implementation of OpenDocument element style:page-layout.

See Also:
Serialized Form

Field Summary
static OdfName ELEMENT_NAME
           
 
Fields inherited from class org.odftoolkit.odfdom.pkg.OdfContainerElementBase
mPackageDocument
 
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
StylePageLayoutElement(OdfFileDom ownerDoc)
          Create the instance of StylePageLayoutElement
 
Method Summary
 void accept(ElementVisitor visitor)
          Accept an visitor instance to allow the visitor to do some operations.
 OdfName getOdfName()
          Get the element name
 String getStyleNameAttribute()
          Receives the value of the ODFDOM attribute representation StyleNameAttribute , See style:name Attribute is mandatory.
 String getStylePageUsageAttribute()
          Receives the value of the ODFDOM attribute representation StylePageUsageAttribute , See style:page-usage
 StyleFooterStyleElement newStyleFooterStyleElement()
          Create child element style:footer-style.
 StyleHeaderStyleElement newStyleHeaderStyleElement()
          Create child element style:header-style.
 StylePageLayoutPropertiesElement newStylePageLayoutPropertiesElement(String styleNumFormatValue)
          Create child element style:page-layout-properties.
 void setStyleNameAttribute(String styleNameValue)
          Sets the value of ODFDOM attribute representation StyleNameAttribute , See style:name
 void setStylePageUsageAttribute(String stylePageUsageValue)
          Sets the value of ODFDOM attribute representation StylePageUsageAttribute , See style:page-usage
 
Methods inherited from class org.odftoolkit.odfdom.dom.element.OdfStyleBase
addStyleUser, compareTo, equals, getFamily, getFamilyName, getOrCreatePropertiesElement, getParentStyle, getProperties, getPropertiesElement, getProperty, getStrictProperties, getStyleProperties, getStylePropertiesDeep, getStyleUserCount, getStyleUsers, hashCode, hasProperty, onOdfNodeInserted, onOdfNodeRemoved, removeProperty, removeStyleUser, setProperties, setProperty
 
Methods inherited from class org.odftoolkit.odfdom.pkg.OdfContainerElementBase
insertBefore, removeChild, replaceChild
 
Methods inherited from class org.odftoolkit.odfdom.pkg.OdfElement
cloneNode, findFirstChildNode, findNextChildNode, findPreviousChildNode, getAncestorAs, getOdfAttribute, getOdfAttribute, getOdfAttributeValue, getParentAs, hasOdfAttribute, onInsertNode, onInsertNode, onRemoveNode, onRemoveNode, setOdfAttribute, setOdfAttributeValue, toString
 
Methods inherited from class org.apache.xerces.dom.ElementNSImpl
getBaseURI, getLocalName, getNamespaceURI, getPrefix, getTypeName, getTypeNamespace, isDerivedFrom, setPrefix, setType, setValues
 
Methods inherited from class org.apache.xerces.dom.ElementImpl
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getDefaultAttributes, getElementsByTagName, getElementsByTagNameNS, getNodeName, getNodeType, 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, 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

StylePageLayoutElement

public StylePageLayoutElement(OdfFileDom ownerDoc)
Create the instance of StylePageLayoutElement

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 style:page-layout.

getStyleNameAttribute

public String getStyleNameAttribute()
Receives the value of the ODFDOM attribute representation StyleNameAttribute , See style:name Attribute is mandatory.

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

setStyleNameAttribute

public void setStyleNameAttribute(String styleNameValue)
Sets the value of ODFDOM attribute representation StyleNameAttribute , See style:name

Parameters:
styleNameValue - The type is String

getStylePageUsageAttribute

public String getStylePageUsageAttribute()
Receives the value of the ODFDOM attribute representation StylePageUsageAttribute , See style:page-usage

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

setStylePageUsageAttribute

public void setStylePageUsageAttribute(String stylePageUsageValue)
Sets the value of ODFDOM attribute representation StylePageUsageAttribute , See style:page-usage

Parameters:
stylePageUsageValue - The type is String

newStyleFooterStyleElement

public StyleFooterStyleElement newStyleFooterStyleElement()
Create child element style:footer-style.

Returns:
the element style:footer-style

newStyleHeaderStyleElement

public StyleHeaderStyleElement newStyleHeaderStyleElement()
Create child element style:header-style.

Returns:
the element style:header-style

newStylePageLayoutPropertiesElement

public StylePageLayoutPropertiesElement newStylePageLayoutPropertiesElement(String styleNumFormatValue)
Create child element style:page-layout-properties.

Parameters:
styleNumFormatValue - the String value of StyleNumFormatAttribute, see style:num-format at specification
Returns:
the element style:page-layout-properties

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


Copyright © 2008-2011 The Apache Software Foundation. All Rights Reserved.