org.odftoolkit.odfdom.dom.element.chart
Class ChartLegendElement

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

public class ChartLegendElement
extends OdfStylableElement

DOM implementation of OpenDocument element chart:legend.

See Also:
Serialized Form

Field Summary
static OdfName ELEMENT_NAME
           
 
Fields inherited from class org.odftoolkit.odfdom.dom.element.OdfStylableElement
mFamily, mStyleNameAttrib
 
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
ChartLegendElement(OdfFileDom ownerDoc)
          Create the instance of ChartLegendElement
 
Method Summary
 void accept(ElementVisitor visitor)
          Accept an visitor instance to allow the visitor to do some operations.
 String getChartLegendAlignAttribute()
          Receives the value of the ODFDOM attribute representation ChartLegendAlignAttribute , See chart:legend-align
 String getChartLegendPositionAttribute()
          Receives the value of the ODFDOM attribute representation ChartLegendPositionAttribute , See chart:legend-position Attribute is mandatory.
 String getChartStyleNameAttribute()
          Receives the value of the ODFDOM attribute representation ChartStyleNameAttribute , See chart:style-name
 OdfName getOdfName()
          Get the element name
 Double getStyleLegendExpansionAspectRatioAttribute()
          Receives the value of the ODFDOM attribute representation StyleLegendExpansionAspectRatioAttribute , See style:legend-expansion-aspect-ratio
 String getStyleLegendExpansionAttribute()
          Receives the value of the ODFDOM attribute representation StyleLegendExpansionAttribute , See style:legend-expansion Attribute is mandatory.
 String getSvgXAttribute()
          Receives the value of the ODFDOM attribute representation SvgXAttribute , See svg:x
 String getSvgYAttribute()
          Receives the value of the ODFDOM attribute representation SvgYAttribute , See svg:y
 TextPElement newTextPElement()
          Create child element text:p.
 void setChartLegendAlignAttribute(String chartLegendAlignValue)
          Sets the value of ODFDOM attribute representation ChartLegendAlignAttribute , See chart:legend-align
 void setChartLegendPositionAttribute(String chartLegendPositionValue)
          Sets the value of ODFDOM attribute representation ChartLegendPositionAttribute , See chart:legend-position
 void setChartStyleNameAttribute(String chartStyleNameValue)
          Sets the value of ODFDOM attribute representation ChartStyleNameAttribute , See chart:style-name
 void setStyleLegendExpansionAspectRatioAttribute(Double styleLegendExpansionAspectRatioValue)
          Sets the value of ODFDOM attribute representation StyleLegendExpansionAspectRatioAttribute , See style:legend-expansion-aspect-ratio
 void setStyleLegendExpansionAttribute(String styleLegendExpansionValue)
          Sets the value of ODFDOM attribute representation StyleLegendExpansionAttribute , See style:legend-expansion
 void setSvgXAttribute(String svgXValue)
          Sets the value of ODFDOM attribute representation SvgXAttribute , See svg:x
 void setSvgYAttribute(String svgYValue)
          Sets the value of ODFDOM attribute representation SvgYAttribute , See svg:y
 
Methods inherited from class org.odftoolkit.odfdom.dom.element.OdfStylableElement
getAutomaticStyle, getAutomaticStyles, getDocumentStyle, getOrCreateUnqiueAutomaticStyle, getProperties, getProperty, getStrictProperties, getStyleFamily, getStyleName, hasAutomaticStyle, hasDocumentStyle, hasProperty, onInsertNode, onRemoveNode, removeProperty, reuseDocumentStyle, setAttributeNS, setDocumentStyle, setProperties, setProperty, setStyleName
 
Methods inherited from class org.odftoolkit.odfdom.pkg.OdfElement
cloneNode, equals, findFirstChildNode, findNextChildNode, findPreviousChildNode, getAncestorAs, getOdfAttribute, getOdfAttribute, getOdfAttributeValue, getParentAs, hasOdfAttribute, insertBefore, onInsertNode, 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, 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

ChartLegendElement

public ChartLegendElement(OdfFileDom ownerDoc)
Create the instance of ChartLegendElement

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 chart:legend.

getChartLegendAlignAttribute

public String getChartLegendAlignAttribute()
Receives the value of the ODFDOM attribute representation ChartLegendAlignAttribute , See chart:legend-align

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

setChartLegendAlignAttribute

public void setChartLegendAlignAttribute(String chartLegendAlignValue)
Sets the value of ODFDOM attribute representation ChartLegendAlignAttribute , See chart:legend-align

Parameters:
chartLegendAlignValue - The type is String

getChartLegendPositionAttribute

public String getChartLegendPositionAttribute()
Receives the value of the ODFDOM attribute representation ChartLegendPositionAttribute , See chart:legend-position Attribute is mandatory.

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

setChartLegendPositionAttribute

public void setChartLegendPositionAttribute(String chartLegendPositionValue)
Sets the value of ODFDOM attribute representation ChartLegendPositionAttribute , See chart:legend-position

Parameters:
chartLegendPositionValue - The type is String

getChartStyleNameAttribute

public String getChartStyleNameAttribute()
Receives the value of the ODFDOM attribute representation ChartStyleNameAttribute , See chart:style-name

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

setChartStyleNameAttribute

public void setChartStyleNameAttribute(String chartStyleNameValue)
Sets the value of ODFDOM attribute representation ChartStyleNameAttribute , See chart:style-name

Parameters:
chartStyleNameValue - The type is String

getStyleLegendExpansionAttribute

public String getStyleLegendExpansionAttribute()
Receives the value of the ODFDOM attribute representation StyleLegendExpansionAttribute , See style:legend-expansion Attribute is mandatory.

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

setStyleLegendExpansionAttribute

public void setStyleLegendExpansionAttribute(String styleLegendExpansionValue)
Sets the value of ODFDOM attribute representation StyleLegendExpansionAttribute , See style:legend-expansion

Parameters:
styleLegendExpansionValue - The type is String

getStyleLegendExpansionAspectRatioAttribute

public Double getStyleLegendExpansionAspectRatioAttribute()
Receives the value of the ODFDOM attribute representation StyleLegendExpansionAspectRatioAttribute , See style:legend-expansion-aspect-ratio

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

setStyleLegendExpansionAspectRatioAttribute

public void setStyleLegendExpansionAspectRatioAttribute(Double styleLegendExpansionAspectRatioValue)
Sets the value of ODFDOM attribute representation StyleLegendExpansionAspectRatioAttribute , See style:legend-expansion-aspect-ratio

Parameters:
styleLegendExpansionAspectRatioValue - The type is Double

getSvgXAttribute

public String getSvgXAttribute()
Receives the value of the ODFDOM attribute representation SvgXAttribute , See svg:x

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

setSvgXAttribute

public void setSvgXAttribute(String svgXValue)
Sets the value of ODFDOM attribute representation SvgXAttribute , See svg:x

Parameters:
svgXValue - The type is String

getSvgYAttribute

public String getSvgYAttribute()
Receives the value of the ODFDOM attribute representation SvgYAttribute , See svg:y

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

setSvgYAttribute

public void setSvgYAttribute(String svgYValue)
Sets the value of ODFDOM attribute representation SvgYAttribute , See svg:y

Parameters:
svgYValue - The type is String

newTextPElement

public TextPElement newTextPElement()
Create child element text:p. Child element is new in Odf 1.2

Returns:
the element text:p

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.