org.docx4j.dml.chart

Class CTLegend

java.lang.Object

org.docx4j.dml.chart.CTLegend

All Implemented Interfaces:

Child

public class CTLegend
extends Object
implements Child

Java class for CT_Legend complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="CT_Legend">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="legendPos" type="{http://schemas.openxmlformats.org/drawingml/2006/chart}CT_LegendPos" minOccurs="0"/>
         <element name="legendEntry" type="{http://schemas.openxmlformats.org/drawingml/2006/chart}CT_LegendEntry" maxOccurs="unbounded" minOccurs="0"/>
         <element name="layout" type="{http://schemas.openxmlformats.org/drawingml/2006/chart}CT_Layout" minOccurs="0"/>
         <element name="overlay" type="{http://schemas.openxmlformats.org/drawingml/2006/chart}CT_Boolean" minOccurs="0"/>
         <element name="spPr" type="{http://schemas.openxmlformats.org/drawingml/2006/main}CT_ShapeProperties" minOccurs="0"/>
         <element name="txPr" type="{http://schemas.openxmlformats.org/drawingml/2006/main}CT_TextBody" minOccurs="0"/>
         <element name="extLst" type="{http://schemas.openxmlformats.org/drawingml/2006/chart}CT_ExtensionList" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected CTExtensionList	extLst
protected CTLayout	layout
protected List<CTLegendEntry>	legendEntry
protected CTLegendPos	legendPos
protected CTBoolean	overlay
protected CTShapeProperties	spPr
protected CTTextBody	txPr

Constructor Summary

Constructors

Constructor and Description
CTLegend()

Method Summary

Modifier and Type	Method and Description
void	afterUnmarshal(Unmarshaller unmarshaller, Object parent) This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
CTExtensionList	getExtLst() Gets the value of the extLst property.
CTLayout	getLayout() Gets the value of the layout property.
List<CTLegendEntry>	getLegendEntry() Gets the value of the legendEntry property.
CTLegendPos	getLegendPos() Gets the value of the legendPos property.
CTBoolean	getOverlay() Gets the value of the overlay property.
Object	getParent() Gets the parent object in the object tree representing the unmarshalled xml document.
CTShapeProperties	getSpPr() Gets the value of the spPr property.
CTTextBody	getTxPr() Gets the value of the txPr property.
void	setExtLst(CTExtensionList value) Sets the value of the extLst property.
void	setLayout(CTLayout value) Sets the value of the layout property.
void	setLegendPos(CTLegendPos value) Sets the value of the legendPos property.
void	setOverlay(CTBoolean value) Sets the value of the overlay property.
void	setParent(Object parent)
void	setSpPr(CTShapeProperties value) Sets the value of the spPr property.
void	setTxPr(CTTextBody value) Sets the value of the txPr property.

Methods inherited from class java.lang.Object

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

Field Detail

legendPos

protected CTLegendPos legendPos

legendEntry

protected List<CTLegendEntry> legendEntry

layout

protected CTLayout layout

overlay

protected CTBoolean overlay

spPr

protected CTShapeProperties spPr

txPr

protected CTTextBody txPr

extLst

protected CTExtensionList extLst

Constructor Detail

CTLegend

public CTLegend()

Method Detail

getLegendPos

public CTLegendPos getLegendPos()

Gets the value of the legendPos property.

Returns:

possible object is CTLegendPos

setLegendPos

public void setLegendPos(CTLegendPos value)

Sets the value of the legendPos property.

Parameters:

value - allowed object is CTLegendPos

getLegendEntry

public List<CTLegendEntry> getLegendEntry()

Gets the value of the legendEntry property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the legendEntry property.

For example, to add a new item, do as follows:

    getLegendEntry().add(newItem);
 

Objects of the following type(s) are allowed in the list CTLegendEntry

getLayout

public CTLayout getLayout()

Gets the value of the layout property.

Returns:

possible object is CTLayout

setLayout

public void setLayout(CTLayout value)

Sets the value of the layout property.

Parameters:

value - allowed object is CTLayout

getOverlay

public CTBoolean getOverlay()

Gets the value of the overlay property.

Returns:

possible object is CTBoolean

setOverlay

public void setOverlay(CTBoolean value)

Sets the value of the overlay property.

Parameters:

value - allowed object is CTBoolean

getSpPr

public CTShapeProperties getSpPr()

Gets the value of the spPr property.

Returns:

possible object is CTShapeProperties

setSpPr

public void setSpPr(CTShapeProperties value)

Sets the value of the spPr property.

Parameters:

value - allowed object is CTShapeProperties

getTxPr

public CTTextBody getTxPr()

Gets the value of the txPr property.

Returns:

possible object is CTTextBody

setTxPr

public void setTxPr(CTTextBody value)

Sets the value of the txPr property.

Parameters:

value - allowed object is CTTextBody

getExtLst

public CTExtensionList getExtLst()

Gets the value of the extLst property.

Returns:

possible object is CTExtensionList

setExtLst

public void setExtLst(CTExtensionList value)

Sets the value of the extLst property.

Parameters:

value - allowed object is CTExtensionList

getParent

public Object getParent()

Gets the parent object in the object tree representing the unmarshalled xml document.

Specified by:

getParent in interface Child

Returns:

The parent object.

setParent

public void setParent(Object parent)

Specified by:

setParent in interface Child

afterUnmarshal

public void afterUnmarshal(Unmarshaller unmarshaller,
                           Object parent)

This method is invoked by the JAXB implementation on each instance when unmarshalling completes.

Parameters:

parent - The parent object in the object tree.

unmarshaller - The unmarshaller that generated the instance.