CTFramePr (docx4j-openxml-objects 8.3.1 API)

java.lang.Object
- org.docx4j.wml.CTFramePr

All Implemented Interfaces:: Child

public class CTFramePr
extends Object
implements Child

Java class for CT_FramePr complex type.

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

 <complexType name="CT_FramePr">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <attribute name="dropCap" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}ST_DropCap" />
       <attribute name="lines" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}ST_DecimalNumber" />
       <attribute name="w" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}ST_TwipsMeasure" />
       <attribute name="h" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}ST_TwipsMeasure" />
       <attribute name="vSpace" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}ST_TwipsMeasure" />
       <attribute name="hSpace" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}ST_TwipsMeasure" />
       <attribute name="wrap" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}ST_Wrap" />
       <attribute name="hAnchor" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}ST_HAnchor" />
       <attribute name="vAnchor" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}ST_VAnchor" />
       <attribute name="x" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}ST_SignedTwipsMeasure" />
       <attribute name="xAlign" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}ST_XAlign" />
       <attribute name="y" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}ST_SignedTwipsMeasure" />
       <attribute name="yAlign" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}ST_YAlign" />
       <attribute name="hRule" type="{http://schemas.openxmlformats.org/wordprocessingml/2006/main}ST_HeightRule" />
       <attribute name="anchorLock" type="{http://www.w3.org/2001/XMLSchema}boolean" default="true" />
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected Boolean`	`anchorLock`
`protected STDropCap`	`dropCap`
`protected BigInteger`	`h`
`protected STHAnchor`	`hAnchor`
`protected STHeightRule`	`hRule`
`protected BigInteger`	`hSpace`
`protected BigInteger`	`lines`
`protected STVAnchor`	`vAnchor`
`protected BigInteger`	`vSpace`
`protected BigInteger`	`w`
`protected STWrap`	`wrap`
`protected BigInteger`	`x`
`protected STXAlign`	`xAlign`
`protected BigInteger`	`y`
`protected STYAlign`	`yAlign`

Constructor Summary

Constructors
Constructor and Description

CTFramePr()

Constructors
Constructor and Description
`CTFramePr()`

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.
`STDropCap`	`getDropCap()` Gets the value of the dropCap property.
`BigInteger`	`getH()` Gets the value of the h property.
`STHAnchor`	`getHAnchor()` Gets the value of the hAnchor property.
`STHeightRule`	`getHRule()` Gets the value of the hRule property.
`BigInteger`	`getHSpace()` Gets the value of the hSpace property.
`BigInteger`	`getLines()` Gets the value of the lines property.
`Object`	`getParent()` Gets the parent object in the object tree representing the unmarshalled xml document.
`STVAnchor`	`getVAnchor()` Gets the value of the vAnchor property.
`BigInteger`	`getVSpace()` Gets the value of the vSpace property.
`BigInteger`	`getW()` Gets the value of the w property.
`STWrap`	`getWrap()` Gets the value of the wrap property.
`BigInteger`	`getX()` Gets the value of the x property.
`STXAlign`	`getXAlign()` Gets the value of the xAlign property.
`BigInteger`	`getY()` Gets the value of the y property.
`STYAlign`	`getYAlign()` Gets the value of the yAlign property.
`boolean`	`isAnchorLock()` Gets the value of the anchorLock property.
`void`	`setAnchorLock(Boolean value)` Sets the value of the anchorLock property.
`void`	`setDropCap(STDropCap value)` Sets the value of the dropCap property.
`void`	`setH(BigInteger value)` Sets the value of the h property.
`void`	`setHAnchor(STHAnchor value)` Sets the value of the hAnchor property.
`void`	`setHRule(STHeightRule value)` Sets the value of the hRule property.
`void`	`setHSpace(BigInteger value)` Sets the value of the hSpace property.
`void`	`setLines(BigInteger value)` Sets the value of the lines property.
`void`	`setParent(Object parent)`
`void`	`setVAnchor(STVAnchor value)` Sets the value of the vAnchor property.
`void`	`setVSpace(BigInteger value)` Sets the value of the vSpace property.
`void`	`setW(BigInteger value)` Sets the value of the w property.
`void`	`setWrap(STWrap value)` Sets the value of the wrap property.
`void`	`setX(BigInteger value)` Sets the value of the x property.
`void`	`setXAlign(STXAlign value)` Sets the value of the xAlign property.
`void`	`setY(BigInteger value)` Sets the value of the y property.
`void`	`setYAlign(STYAlign value)` Sets the value of the yAlign property.

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

- Field Detail
  - dropCap
```
protected STDropCap dropCap
```
  - lines
```
protected BigInteger lines
```
  - w
```
protected BigInteger w
```
  - h
```
protected BigInteger h
```
  - vSpace
```
protected BigInteger vSpace
```
  - hSpace
```
protected BigInteger hSpace
```
  - wrap
```
protected STWrap wrap
```
  - hAnchor
```
protected STHAnchor hAnchor
```
  - vAnchor
```
protected STVAnchor vAnchor
```
  - x
```
protected BigInteger x
```
  - xAlign
```
protected STXAlign xAlign
```
  - y
```
protected BigInteger y
```
  - yAlign
```
protected STYAlign yAlign
```
  - hRule
```
protected STHeightRule hRule
```
  - anchorLock
```
protected Boolean anchorLock
```
- Constructor Detail
  - CTFramePr
```
public CTFramePr()
```
- Method Detail
  - getDropCap
```
public STDropCap getDropCap()
```
    Gets the value of the dropCap property.
    
    Returns:
    
    possible object is STDropCap
  - setDropCap
```
public void setDropCap(STDropCap value)
```
    Sets the value of the dropCap property.
    
    Parameters:
    
    value - allowed object is STDropCap
  - getLines
```
public BigInteger getLines()
```
    Gets the value of the lines property.
    
    Returns:
    
    possible object is BigInteger
  - setLines
```
public void setLines(BigInteger value)
```
    Sets the value of the lines property.
    
    Parameters:
    
    value - allowed object is BigInteger
  - getW
```
public BigInteger getW()
```
    Gets the value of the w property.
    
    Returns:
    
    possible object is BigInteger
  - setW
```
public void setW(BigInteger value)
```
    Sets the value of the w property.
    
    Parameters:
    
    value - allowed object is BigInteger
  - getH
```
public BigInteger getH()
```
    Gets the value of the h property.
    
    Returns:
    
    possible object is BigInteger
  - setH
```
public void setH(BigInteger value)
```
    Sets the value of the h property.
    
    Parameters:
    
    value - allowed object is BigInteger
  - getVSpace
```
public BigInteger getVSpace()
```
    Gets the value of the vSpace property.
    
    Returns:
    
    possible object is BigInteger
  - setVSpace
```
public void setVSpace(BigInteger value)
```
    Sets the value of the vSpace property.
    
    Parameters:
    
    value - allowed object is BigInteger
  - getHSpace
```
public BigInteger getHSpace()
```
    Gets the value of the hSpace property.
    
    Returns:
    
    possible object is BigInteger
  - setHSpace
```
public void setHSpace(BigInteger value)
```
    Sets the value of the hSpace property.
    
    Parameters:
    
    value - allowed object is BigInteger
  - getWrap
```
public STWrap getWrap()
```
    Gets the value of the wrap property.
    
    Returns:
    
    possible object is STWrap
  - setWrap
```
public void setWrap(STWrap value)
```
    Sets the value of the wrap property.
    
    Parameters:
    
    value - allowed object is STWrap
  - getHAnchor
```
public STHAnchor getHAnchor()
```
    Gets the value of the hAnchor property.
    
    Returns:
    
    possible object is STHAnchor
  - setHAnchor
```
public void setHAnchor(STHAnchor value)
```
    Sets the value of the hAnchor property.
    
    Parameters:
    
    value - allowed object is STHAnchor
  - getVAnchor
```
public STVAnchor getVAnchor()
```
    Gets the value of the vAnchor property.
    
    Returns:
    
    possible object is STVAnchor
  - setVAnchor
```
public void setVAnchor(STVAnchor value)
```
    Sets the value of the vAnchor property.
    
    Parameters:
    
    value - allowed object is STVAnchor
  - getX
```
public BigInteger getX()
```
    Gets the value of the x property.
    
    Returns:
    
    possible object is BigInteger
  - setX
```
public void setX(BigInteger value)
```
    Sets the value of the x property.
    
    Parameters:
    
    value - allowed object is BigInteger
  - getXAlign
```
public STXAlign getXAlign()
```
    Gets the value of the xAlign property.
    
    Returns:
    
    possible object is STXAlign
  - setXAlign
```
public void setXAlign(STXAlign value)
```
    Sets the value of the xAlign property.
    
    Parameters:
    
    value - allowed object is STXAlign
  - getY
```
public BigInteger getY()
```
    Gets the value of the y property.
    
    Returns:
    
    possible object is BigInteger
  - setY
```
public void setY(BigInteger value)
```
    Sets the value of the y property.
    
    Parameters:
    
    value - allowed object is BigInteger
  - getYAlign
```
public STYAlign getYAlign()
```
    Gets the value of the yAlign property.
    
    Returns:
    
    possible object is STYAlign
  - setYAlign
```
public void setYAlign(STYAlign value)
```
    Sets the value of the yAlign property.
    
    Parameters:
    
    value - allowed object is STYAlign
  - getHRule
```
public STHeightRule getHRule()
```
    Gets the value of the hRule property.
    
    Returns:
    
    possible object is STHeightRule
  - setHRule
```
public void setHRule(STHeightRule value)
```
    Sets the value of the hRule property.
    
    Parameters:
    
    value - allowed object is STHeightRule
  - isAnchorLock
```
public boolean isAnchorLock()
```
    Gets the value of the anchorLock property.
    
    Returns:
    
    possible object is Boolean
  - setAnchorLock
```
public void setAnchorLock(Boolean value)
```
    Sets the value of the anchorLock 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 CTFramePr

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

dropCap

lines

w

h

vSpace

hSpace

wrap

hAnchor

vAnchor

x

xAlign

y

yAlign

hRule

anchorLock

Constructor Detail

CTFramePr

Method Detail

getDropCap

setDropCap

getLines

setLines

getW

setW

getH

setH

getVSpace

setVSpace

getHSpace

setHSpace

getWrap

setWrap

getHAnchor

setHAnchor

getVAnchor

setVAnchor

getX

setX

getXAlign

setXAlign

getY

setY

getYAlign

setYAlign

getHRule

setHRule

isAnchorLock

setAnchorLock

getParent

setParent

afterUnmarshal