CTForEach (docx4j-openxml-objects 8.3.9 API)

java.lang.Object
- org.docx4j.dml.diagram.CTForEach

All Implemented Interfaces:: Child

public class CTForEach
extends java.lang.Object
implements Child

Java class for CT_ForEach complex type.

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

 <complexType name="CT_ForEach">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <choice maxOccurs="unbounded" minOccurs="0">
         <element name="alg" type="{http://schemas.openxmlformats.org/drawingml/2006/diagram}CT_Algorithm" minOccurs="0"/>
         <element name="shape" type="{http://schemas.openxmlformats.org/drawingml/2006/diagram}CT_Shape" minOccurs="0"/>
         <element name="presOf" type="{http://schemas.openxmlformats.org/drawingml/2006/diagram}CT_PresentationOf" minOccurs="0"/>
         <element name="constrLst" type="{http://schemas.openxmlformats.org/drawingml/2006/diagram}CT_Constraints" minOccurs="0"/>
         <element name="ruleLst" type="{http://schemas.openxmlformats.org/drawingml/2006/diagram}CT_Rules" minOccurs="0"/>
         <element name="forEach" type="{http://schemas.openxmlformats.org/drawingml/2006/diagram}CT_ForEach"/>
         <element name="layoutNode" type="{http://schemas.openxmlformats.org/drawingml/2006/diagram}CT_LayoutNode"/>
         <element name="choose" type="{http://schemas.openxmlformats.org/drawingml/2006/diagram}CT_Choose"/>
         <element name="extLst" type="{http://schemas.openxmlformats.org/drawingml/2006/main}CT_OfficeArtExtensionList" minOccurs="0"/>
       </choice>
       <attGroup ref="{http://schemas.openxmlformats.org/drawingml/2006/diagram}AG_IteratorAttributes"/>
       <attribute name="name" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="ref" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.List<java.lang.Object>`	`algOrShapeOrPresOf`
`protected java.util.List<STAxisType>`	`axis`
`protected java.util.List<java.lang.Long>`	`cnt`
`protected java.util.List<java.lang.Boolean>`	`hideLastTrans`
`protected java.lang.String`	`name`
`protected java.util.List<STElementType>`	`ptType`
`protected java.lang.String`	`ref`
`protected java.util.List<java.lang.Integer>`	`st`
`protected java.util.List<java.lang.Integer>`	`step`

Constructor Summary

Constructors
Constructor and Description

CTForEach()

Constructors
Constructor and Description
`CTForEach()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterUnmarshal(javax.xml.bind.Unmarshaller unmarshaller, java.lang.Object parent)` This method is invoked by the JAXB implementation on each instance when unmarshalling completes.
`java.util.List<java.lang.Object>`	`getAlgOrShapeOrPresOf()` Gets the value of the algOrShapeOrPresOf property.
`java.util.List<STAxisType>`	`getAxis()` Gets the value of the axis property.
`java.util.List<java.lang.Long>`	`getCnt()` Gets the value of the cnt property.
`java.util.List<java.lang.Boolean>`	`getHideLastTrans()` Gets the value of the hideLastTrans property.
`java.lang.String`	`getName()` Gets the value of the name property.
`java.lang.Object`	`getParent()` Gets the parent object in the object tree representing the unmarshalled xml document.
`java.util.List<STElementType>`	`getPtType()` Gets the value of the ptType property.
`java.lang.String`	`getRef()` Gets the value of the ref property.
`java.util.List<java.lang.Integer>`	`getSt()` Gets the value of the st property.
`java.util.List<java.lang.Integer>`	`getStep()` Gets the value of the step property.
`void`	`setName(java.lang.String value)` Sets the value of the name property.
`void`	`setParent(java.lang.Object parent)`
`void`	`setRef(java.lang.String value)` Sets the value of the ref property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - algOrShapeOrPresOf
```
protected java.util.List<java.lang.Object> algOrShapeOrPresOf
```
  - name
```
protected java.lang.String name
```
  - ref
```
protected java.lang.String ref
```
  - axis
```
protected java.util.List<STAxisType> axis
```
  - ptType
```
protected java.util.List<STElementType> ptType
```
  - hideLastTrans
```
protected java.util.List<java.lang.Boolean> hideLastTrans
```
  - st
```
protected java.util.List<java.lang.Integer> st
```
  - cnt
```
protected java.util.List<java.lang.Long> cnt
```
  - step
```
protected java.util.List<java.lang.Integer> step
```
- Constructor Detail
  - CTForEach
```
public CTForEach()
```
- Method Detail
  - getAlgOrShapeOrPresOf
```
public java.util.List<java.lang.Object> getAlgOrShapeOrPresOf()
```
    Gets the value of the algOrShapeOrPresOf 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 algOrShapeOrPresOf property.
    For example, to add a new item, do as follows:
```
    getAlgOrShapeOrPresOf().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list CTAlgorithm CTShape CTPresentationOf CTConstraints CTRules CTForEach CTLayoutNode CTChoose CTOfficeArtExtensionList
  - getName
```
public java.lang.String getName()
```
    Gets the value of the name property.
    
    Returns:
    
    possible object is String
  - setName
```
public void setName(java.lang.String value)
```
    Sets the value of the name property.
    
    Parameters:
    
    value - allowed object is String
  - getRef
```
public java.lang.String getRef()
```
    Gets the value of the ref property.
    
    Returns:
    
    possible object is String
  - setRef
```
public void setRef(java.lang.String value)
```
    Sets the value of the ref property.
    
    Parameters:
    
    value - allowed object is String
  - getAxis
```
public java.util.List<STAxisType> getAxis()
```
    Gets the value of the axis 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 axis property.
    For example, to add a new item, do as follows:
```
    getAxis().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list STAxisType
  - getPtType
```
public java.util.List<STElementType> getPtType()
```
    Gets the value of the ptType 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 ptType property.
    For example, to add a new item, do as follows:
```
    getPtType().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list STElementType
  - getHideLastTrans
```
public java.util.List<java.lang.Boolean> getHideLastTrans()
```
    Gets the value of the hideLastTrans 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 hideLastTrans property.
    For example, to add a new item, do as follows:
```
    getHideLastTrans().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Boolean
  - getSt
```
public java.util.List<java.lang.Integer> getSt()
```
    Gets the value of the st 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 st property.
    For example, to add a new item, do as follows:
```
    getSt().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Integer
  - getCnt
```
public java.util.List<java.lang.Long> getCnt()
```
    Gets the value of the cnt 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 cnt property.
    For example, to add a new item, do as follows:
```
    getCnt().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Long
  - getStep
```
public java.util.List<java.lang.Integer> getStep()
```
    Gets the value of the step 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 step property.
    For example, to add a new item, do as follows:
```
    getStep().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Integer
  - getParent
```
public java.lang.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(java.lang.Object parent)
```
    Specified by:
    
    setParent in interface Child
  - afterUnmarshal
```
public void afterUnmarshal(javax.xml.bind.Unmarshaller unmarshaller,
                           java.lang.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.

Class CTForEach

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

algOrShapeOrPresOf

name

ref

axis

ptType

hideLastTrans

st

cnt

step

Constructor Detail

CTForEach

Method Detail

getAlgOrShapeOrPresOf

getName

setName

getRef

setRef

getAxis

getPtType

getHideLastTrans

getSt

getCnt

getStep

getParent

setParent

afterUnmarshal