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

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.dom.element.OdfStylePropertiesBase
                              extended by org.odftoolkit.odfdom.dom.element.style.StyleSectionPropertiesElement
All Implemented Interfaces:
Serializable, Cloneable, Element, EventTarget, Node, NodeList, TypeInfo

public class StyleSectionPropertiesElement
extends OdfStylePropertiesBase

DOM implementation of OpenDocument element style:section-properties.

See Also:
Serialized Form

Field Summary
static OdfStyleProperty BackgroundColor
           
static OdfStyleProperty DontBalanceTextColumns
           
static OdfStyleProperty Editable
           
static OdfName ELEMENT_NAME
           
static OdfStyleProperty MarginLeft
           
static OdfStyleProperty MarginRight
           
static OdfStyleProperty Protect
           
static OdfStyleProperty WritingMode
           
 
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
StyleSectionPropertiesElement(OdfFileDom ownerDoc)
          Create the instance of StyleSectionPropertiesElement
 
Method Summary
 void accept(ElementVisitor visitor)
          Accept an visitor instance to allow the visitor to do some operations.
 String getFoBackgroundColorAttribute()
          Receives the value of the ODFDOM attribute representation FoBackgroundColorAttribute , See fo:background-color
 String getFoMarginLeftAttribute()
          Receives the value of the ODFDOM attribute representation FoMarginLeftAttribute , See fo:margin-left
 String getFoMarginRightAttribute()
          Receives the value of the ODFDOM attribute representation FoMarginRightAttribute , See fo:margin-right
 OdfName getOdfName()
          Get the element name
 Boolean getStyleEditableAttribute()
          Receives the value of the ODFDOM attribute representation StyleEditableAttribute , See style:editable
 String getStyleProtectAttribute()
          Receives the value of the ODFDOM attribute representation StyleProtectAttribute , See style:protect
 String getStyleWritingModeAttribute()
          Receives the value of the ODFDOM attribute representation StyleWritingModeAttribute , See style:writing-mode
 Boolean getTextDontBalanceTextColumnsAttribute()
          Receives the value of the ODFDOM attribute representation TextDontBalanceTextColumnsAttribute , See text:dont-balance-text-columns
 StyleBackgroundImageElement newStyleBackgroundImageElement()
          Create child element style:background-image.
 StyleColumnsElement newStyleColumnsElement(int foColumnCountValue)
          Create child element style:columns.
 TextNotesConfigurationElement newTextNotesConfigurationElement(String styleNumFormatValue, String textNoteClassValue)
          Create child element text:notes-configuration.
 void setFoBackgroundColorAttribute(String foBackgroundColorValue)
          Sets the value of ODFDOM attribute representation FoBackgroundColorAttribute , See fo:background-color
 void setFoMarginLeftAttribute(String foMarginLeftValue)
          Sets the value of ODFDOM attribute representation FoMarginLeftAttribute , See fo:margin-left
 void setFoMarginRightAttribute(String foMarginRightValue)
          Sets the value of ODFDOM attribute representation FoMarginRightAttribute , See fo:margin-right
 void setStyleEditableAttribute(Boolean styleEditableValue)
          Sets the value of ODFDOM attribute representation StyleEditableAttribute , See style:editable
 void setStyleProtectAttribute(String styleProtectValue)
          Sets the value of ODFDOM attribute representation StyleProtectAttribute , See style:protect
 void setStyleWritingModeAttribute(String styleWritingModeValue)
          Sets the value of ODFDOM attribute representation StyleWritingModeAttribute , See style:writing-mode
 void setTextDontBalanceTextColumnsAttribute(Boolean textDontBalanceTextColumnsValue)
          Sets the value of ODFDOM attribute representation TextDontBalanceTextColumnsAttribute , See text:dont-balance-text-columns
 
Methods inherited from class org.odftoolkit.odfdom.dom.element.OdfStylePropertiesBase
hashCode
 
Methods inherited from class org.odftoolkit.odfdom.pkg.OdfElement
cloneNode, 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
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

BackgroundColor

public static final OdfStyleProperty BackgroundColor

MarginLeft

public static final OdfStyleProperty MarginLeft

MarginRight

public static final OdfStyleProperty MarginRight

Editable

public static final OdfStyleProperty Editable

Protect

public static final OdfStyleProperty Protect

WritingMode

public static final OdfStyleProperty WritingMode

DontBalanceTextColumns

public static final OdfStyleProperty DontBalanceTextColumns
Constructor Detail

StyleSectionPropertiesElement

public StyleSectionPropertiesElement(OdfFileDom ownerDoc)
Create the instance of StyleSectionPropertiesElement

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:section-properties.

getFoBackgroundColorAttribute

public String getFoBackgroundColorAttribute()
Receives the value of the ODFDOM attribute representation FoBackgroundColorAttribute , See fo:background-color

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

setFoBackgroundColorAttribute

public void setFoBackgroundColorAttribute(String foBackgroundColorValue)
Sets the value of ODFDOM attribute representation FoBackgroundColorAttribute , See fo:background-color

Parameters:
foBackgroundColorValue - The type is String

getFoMarginLeftAttribute

public String getFoMarginLeftAttribute()
Receives the value of the ODFDOM attribute representation FoMarginLeftAttribute , See fo:margin-left

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

setFoMarginLeftAttribute

public void setFoMarginLeftAttribute(String foMarginLeftValue)
Sets the value of ODFDOM attribute representation FoMarginLeftAttribute , See fo:margin-left

Parameters:
foMarginLeftValue - The type is String

getFoMarginRightAttribute

public String getFoMarginRightAttribute()
Receives the value of the ODFDOM attribute representation FoMarginRightAttribute , See fo:margin-right

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

setFoMarginRightAttribute

public void setFoMarginRightAttribute(String foMarginRightValue)
Sets the value of ODFDOM attribute representation FoMarginRightAttribute , See fo:margin-right

Parameters:
foMarginRightValue - The type is String

getStyleEditableAttribute

public Boolean getStyleEditableAttribute()
Receives the value of the ODFDOM attribute representation StyleEditableAttribute , See style:editable

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

setStyleEditableAttribute

public void setStyleEditableAttribute(Boolean styleEditableValue)
Sets the value of ODFDOM attribute representation StyleEditableAttribute , See style:editable

Parameters:
styleEditableValue - The type is Boolean

getStyleProtectAttribute

public String getStyleProtectAttribute()
Receives the value of the ODFDOM attribute representation StyleProtectAttribute , See style:protect

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

setStyleProtectAttribute

public void setStyleProtectAttribute(String styleProtectValue)
Sets the value of ODFDOM attribute representation StyleProtectAttribute , See style:protect

Parameters:
styleProtectValue - The type is String

getStyleWritingModeAttribute

public String getStyleWritingModeAttribute()
Receives the value of the ODFDOM attribute representation StyleWritingModeAttribute , See style:writing-mode

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

setStyleWritingModeAttribute

public void setStyleWritingModeAttribute(String styleWritingModeValue)
Sets the value of ODFDOM attribute representation StyleWritingModeAttribute , See style:writing-mode

Parameters:
styleWritingModeValue - The type is String

getTextDontBalanceTextColumnsAttribute

public Boolean getTextDontBalanceTextColumnsAttribute()
Receives the value of the ODFDOM attribute representation TextDontBalanceTextColumnsAttribute , See text:dont-balance-text-columns

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

setTextDontBalanceTextColumnsAttribute

public void setTextDontBalanceTextColumnsAttribute(Boolean textDontBalanceTextColumnsValue)
Sets the value of ODFDOM attribute representation TextDontBalanceTextColumnsAttribute , See text:dont-balance-text-columns

Parameters:
textDontBalanceTextColumnsValue - The type is Boolean

newStyleBackgroundImageElement

public StyleBackgroundImageElement newStyleBackgroundImageElement()
Create child element style:background-image. Child element is new in Odf 1.2

Returns:
the element style:background-image

newStyleColumnsElement

public StyleColumnsElement newStyleColumnsElement(int foColumnCountValue)
Create child element style:columns.

Parameters:
foColumnCountValue - the Integer value of FoColumnCountAttribute, see fo:column-count at specification Child element is new in Odf 1.2
Returns:
the element style:columns

newTextNotesConfigurationElement

public TextNotesConfigurationElement newTextNotesConfigurationElement(String styleNumFormatValue,
                                                                      String textNoteClassValue)
Create child element text:notes-configuration.

Parameters:
styleNumFormatValue - the String value of StyleNumFormatAttribute, see style:num-format at specification
textNoteClassValue - the String value of TextNoteClassAttribute, see text:note-class at specification Child element is new in Odf 1.2
Returns:
the element text:notes-configuration

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.