CTCfRule (docx4j 6.0.1 API)

java.lang.Object
- org.xlsx4j.sml.CTCfRule

All Implemented Interfaces:: Child

public class CTCfRule
extends Object
implements Child

Java class for CT_CfRule complex type.

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

 <complexType name="CT_CfRule">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="formula" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}ST_Formula" maxOccurs="3" minOccurs="0"/>
         <element name="colorScale" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_ColorScale" minOccurs="0"/>
         <element name="dataBar" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_DataBar" minOccurs="0"/>
         <element name="iconSet" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_IconSet" minOccurs="0"/>
         <element name="extLst" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}CT_ExtensionList" minOccurs="0"/>
       </sequence>
       <attribute name="type" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}ST_CfType" />
       <attribute name="dxfId" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}ST_DxfId" />
       <attribute name="priority" use="required" type="{http://www.w3.org/2001/XMLSchema}int" />
       <attribute name="stopIfTrue" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="aboveAverage" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
       <attribute name="percent" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="bottom" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="operator" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}ST_ConditionalFormattingOperator" />
       <attribute name="text" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="timePeriod" type="{http://schemas.openxmlformats.org/spreadsheetml/2006/main}ST_TimePeriod" />
       <attribute name="rank" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" />
       <attribute name="stdDev" type="{http://www.w3.org/2001/XMLSchema}int" />
       <attribute name="equalAverage" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected Boolean`	`aboveAverage`
`protected Boolean`	`bottom`
`protected CTColorScale`	`colorScale`
`protected CTDataBar`	`dataBar`
`protected Long`	`dxfId`
`protected Boolean`	`equalAverage`
`protected CTExtensionList`	`extLst`
`protected List<String>`	`formula`
`protected CTIconSet`	`iconSet`
`protected STConditionalFormattingOperator`	`operator`
`protected Boolean`	`percent`
`protected int`	`priority`
`protected Long`	`rank`
`protected Integer`	`stdDev`
`protected Boolean`	`stopIfTrue`
`protected String`	`text`
`protected STTimePeriod`	`timePeriod`
`protected STCfType`	`type`

Constructor Summary

Constructors
Constructor and Description

CTCfRule()

Constructors
Constructor and Description
`CTCfRule()`

Method Summary

All Methods Instance Methods Concrete Methods
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.
`CTColorScale`	`getColorScale()` Gets the value of the colorScale property.
`CTDataBar`	`getDataBar()` Gets the value of the dataBar property.
`Long`	`getDxfId()` Gets the value of the dxfId property.
`CTExtensionList`	`getExtLst()` Gets the value of the extLst property.
`List<String>`	`getFormula()` Gets the value of the formula property.
`CTIconSet`	`getIconSet()` Gets the value of the iconSet property.
`STConditionalFormattingOperator`	`getOperator()` Gets the value of the operator property.
`Object`	`getParent()` Gets the parent object in the object tree representing the unmarshalled xml document.
`int`	`getPriority()` Gets the value of the priority property.
`Long`	`getRank()` Gets the value of the rank property.
`Integer`	`getStdDev()` Gets the value of the stdDev property.
`String`	`getText()` Gets the value of the text property.
`STTimePeriod`	`getTimePeriod()` Gets the value of the timePeriod property.
`STCfType`	`getType()` Gets the value of the type property.
`boolean`	`isAboveAverage()` Gets the value of the aboveAverage property.
`boolean`	`isBottom()` Gets the value of the bottom property.
`boolean`	`isEqualAverage()` Gets the value of the equalAverage property.
`boolean`	`isPercent()` Gets the value of the percent property.
`boolean`	`isStopIfTrue()` Gets the value of the stopIfTrue property.
`void`	`setAboveAverage(Boolean value)` Sets the value of the aboveAverage property.
`void`	`setBottom(Boolean value)` Sets the value of the bottom property.
`void`	`setColorScale(CTColorScale value)` Sets the value of the colorScale property.
`void`	`setDataBar(CTDataBar value)` Sets the value of the dataBar property.
`void`	`setDxfId(Long value)` Sets the value of the dxfId property.
`void`	`setEqualAverage(Boolean value)` Sets the value of the equalAverage property.
`void`	`setExtLst(CTExtensionList value)` Sets the value of the extLst property.
`void`	`setIconSet(CTIconSet value)` Sets the value of the iconSet property.
`void`	`setOperator(STConditionalFormattingOperator value)` Sets the value of the operator property.
`void`	`setParent(Object parent)`
`void`	`setPercent(Boolean value)` Sets the value of the percent property.
`void`	`setPriority(int value)` Sets the value of the priority property.
`void`	`setRank(Long value)` Sets the value of the rank property.
`void`	`setStdDev(Integer value)` Sets the value of the stdDev property.
`void`	`setStopIfTrue(Boolean value)` Sets the value of the stopIfTrue property.
`void`	`setText(String value)` Sets the value of the text property.
`void`	`setTimePeriod(STTimePeriod value)` Sets the value of the timePeriod property.
`void`	`setType(STCfType value)` Sets the value of the type property.

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

- Field Detail
  - formula
```
protected List<String> formula
```
  - colorScale
```
protected CTColorScale colorScale
```
  - dataBar
```
protected CTDataBar dataBar
```
  - iconSet
```
protected CTIconSet iconSet
```
  - extLst
```
protected CTExtensionList extLst
```
  - type
```
protected STCfType type
```
  - dxfId
```
protected Long dxfId
```
  - priority
```
protected int priority
```
  - stopIfTrue
```
protected Boolean stopIfTrue
```
  - aboveAverage
```
protected Boolean aboveAverage
```
  - percent
```
protected Boolean percent
```
  - bottom
```
protected Boolean bottom
```
  - operator
```
protected STConditionalFormattingOperator operator
```
  - text
```
protected String text
```
  - timePeriod
```
protected STTimePeriod timePeriod
```
  - rank
```
protected Long rank
```
  - stdDev
```
protected Integer stdDev
```
  - equalAverage
```
protected Boolean equalAverage
```
- Constructor Detail
  - CTCfRule
```
public CTCfRule()
```
- Method Detail
  - getFormula
```
public List<String> getFormula()
```
    Gets the value of the formula 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 formula property.
    For example, to add a new item, do as follows:
```
    getFormula().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list String
  - getColorScale
```
public CTColorScale getColorScale()
```
    Gets the value of the colorScale property.
    
    Returns:
    
    possible object is CTColorScale
  - setColorScale
```
public void setColorScale(CTColorScale value)
```
    Sets the value of the colorScale property.
    
    Parameters:
    
    value - allowed object is CTColorScale
  - getDataBar
```
public CTDataBar getDataBar()
```
    Gets the value of the dataBar property.
    
    Returns:
    
    possible object is CTDataBar
  - setDataBar
```
public void setDataBar(CTDataBar value)
```
    Sets the value of the dataBar property.
    
    Parameters:
    
    value - allowed object is CTDataBar
  - getIconSet
```
public CTIconSet getIconSet()
```
    Gets the value of the iconSet property.
    
    Returns:
    
    possible object is CTIconSet
  - setIconSet
```
public void setIconSet(CTIconSet value)
```
    Sets the value of the iconSet property.
    
    Parameters:
    
    value - allowed object is CTIconSet
  - 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
  - getType
```
public STCfType getType()
```
    Gets the value of the type property.
    
    Returns:
    
    possible object is STCfType
  - setType
```
public void setType(STCfType value)
```
    Sets the value of the type property.
    
    Parameters:
    
    value - allowed object is STCfType
  - getDxfId
```
public Long getDxfId()
```
    Gets the value of the dxfId property.
    
    Returns:
    
    possible object is Long
  - setDxfId
```
public void setDxfId(Long value)
```
    Sets the value of the dxfId property.
    
    Parameters:
    
    value - allowed object is Long
  - getPriority
```
public int getPriority()
```
    Gets the value of the priority property.
  - setPriority
```
public void setPriority(int value)
```
    Sets the value of the priority property.
  - isStopIfTrue
```
public boolean isStopIfTrue()
```
    Gets the value of the stopIfTrue property.
    
    Returns:
    
    possible object is Boolean
  - setStopIfTrue
```
public void setStopIfTrue(Boolean value)
```
    Sets the value of the stopIfTrue property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isAboveAverage
```
public boolean isAboveAverage()
```
    Gets the value of the aboveAverage property.
    
    Returns:
    
    possible object is Boolean
  - setAboveAverage
```
public void setAboveAverage(Boolean value)
```
    Sets the value of the aboveAverage property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isPercent
```
public boolean isPercent()
```
    Gets the value of the percent property.
    
    Returns:
    
    possible object is Boolean
  - setPercent
```
public void setPercent(Boolean value)
```
    Sets the value of the percent property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isBottom
```
public boolean isBottom()
```
    Gets the value of the bottom property.
    
    Returns:
    
    possible object is Boolean
  - setBottom
```
public void setBottom(Boolean value)
```
    Sets the value of the bottom property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getOperator
```
public STConditionalFormattingOperator getOperator()
```
    Gets the value of the operator property.
    
    Returns:
    
    possible object is STConditionalFormattingOperator
  - setOperator
```
public void setOperator(STConditionalFormattingOperator value)
```
    Sets the value of the operator property.
    
    Parameters:
    
    value - allowed object is STConditionalFormattingOperator
  - getText
```
public String getText()
```
    Gets the value of the text property.
    
    Returns:
    
    possible object is String
  - setText
```
public void setText(String value)
```
    Sets the value of the text property.
    
    Parameters:
    
    value - allowed object is String
  - getTimePeriod
```
public STTimePeriod getTimePeriod()
```
    Gets the value of the timePeriod property.
    
    Returns:
    
    possible object is STTimePeriod
  - setTimePeriod
```
public void setTimePeriod(STTimePeriod value)
```
    Sets the value of the timePeriod property.
    
    Parameters:
    
    value - allowed object is STTimePeriod
  - getRank
```
public Long getRank()
```
    Gets the value of the rank property.
    
    Returns:
    
    possible object is Long
  - setRank
```
public void setRank(Long value)
```
    Sets the value of the rank property.
    
    Parameters:
    
    value - allowed object is Long
  - getStdDev
```
public Integer getStdDev()
```
    Gets the value of the stdDev property.
    
    Returns:
    
    possible object is Integer
  - setStdDev
```
public void setStdDev(Integer value)
```
    Sets the value of the stdDev property.
    
    Parameters:
    
    value - allowed object is Integer
  - isEqualAverage
```
public boolean isEqualAverage()
```
    Gets the value of the equalAverage property.
    
    Returns:
    
    possible object is Boolean
  - setEqualAverage
```
public void setEqualAverage(Boolean value)
```
    Sets the value of the equalAverage property.
    
    Parameters:
    
    value - allowed object is Boolean
  - 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.

Class CTCfRule

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

formula

colorScale

dataBar

iconSet

extLst

type

dxfId

priority

stopIfTrue

aboveAverage

percent

bottom

operator

text

timePeriod

rank

stdDev

equalAverage

Constructor Detail

CTCfRule

Method Detail

getFormula

getColorScale

setColorScale

getDataBar

setDataBar

getIconSet

setIconSet

getExtLst

setExtLst

getType

setType

getDxfId

setDxfId

getPriority

setPriority

isStopIfTrue

setStopIfTrue

isAboveAverage

setAboveAverage

isPercent

setPercent

isBottom

setBottom

getOperator

setOperator

getText

setText

getTimePeriod

setTimePeriod

getRank

setRank

getStdDev

setStdDev

isEqualAverage

setEqualAverage

getParent

setParent

afterUnmarshal