Anchor (docx4j-openxml-objects 8.3.4 API)

java.lang.Object
- org.docx4j.dml.wordprocessingDrawing.Anchor

All Implemented Interfaces:: Child

public class Anchor
extends Object
implements Child

Java class for CT_Anchor complex type.

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

 <complexType name="CT_Anchor">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="simplePos" type="{http://schemas.openxmlformats.org/drawingml/2006/main}CT_Point2D"/>
         <element name="positionH" type="{http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing}CT_PosH"/>
         <element name="positionV" type="{http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing}CT_PosV"/>
         <element name="extent" type="{http://schemas.openxmlformats.org/drawingml/2006/main}CT_PositiveSize2D"/>
         <element name="effectExtent" type="{http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing}CT_EffectExtent" minOccurs="0"/>
         <group ref="{http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing}EG_WrapType"/>
         <element name="docPr" type="{http://schemas.openxmlformats.org/drawingml/2006/main}CT_NonVisualDrawingProps"/>
         <element name="cNvGraphicFramePr" type="{http://schemas.openxmlformats.org/drawingml/2006/main}CT_NonVisualGraphicFrameProperties" minOccurs="0"/>
         <element ref="{http://schemas.openxmlformats.org/drawingml/2006/main}graphic"/>
         <element ref="{http://schemas.microsoft.com/office/word/2010/wordprocessingDrawing}sizeRelH" minOccurs="0"/>
         <element ref="{http://schemas.microsoft.com/office/word/2010/wordprocessingDrawing}sizeRelV" minOccurs="0"/>
       </sequence>
       <attribute name="distT" type="{http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing}ST_WrapDistance" />
       <attribute name="distB" type="{http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing}ST_WrapDistance" />
       <attribute name="distL" type="{http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing}ST_WrapDistance" />
       <attribute name="distR" type="{http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing}ST_WrapDistance" />
       <attribute name="simplePos" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="relativeHeight" use="required" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" />
       <attribute name="behindDoc" use="required" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="locked" use="required" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="layoutInCell" use="required" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="hidden" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="allowOverlap" use="required" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute ref="{http://schemas.microsoft.com/office/word/2010/wordprocessingDrawing}anchorId"/>
       <attribute ref="{http://schemas.microsoft.com/office/word/2010/wordprocessingDrawing}editId"/>
     </restriction>
   </complexContent>
 </complexType>

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`allowOverlap`
`protected byte[]`	`anchorId`
`protected boolean`	`behindDoc`
`protected CTNonVisualGraphicFrameProperties`	`cNvGraphicFramePr`
`protected Long`	`distB`
`protected Long`	`distL`
`protected Long`	`distR`
`protected Long`	`distT`
`protected CTNonVisualDrawingProps`	`docPr`
`protected byte[]`	`editId`
`protected CTEffectExtent`	`effectExtent`
`protected CTPositiveSize2D`	`extent`
`protected Graphic`	`graphic`
`protected Boolean`	`hidden`
`protected boolean`	`layoutInCell`
`protected boolean`	`locked`
`protected CTPosH`	`positionH`
`protected CTPosV`	`positionV`
`protected long`	`relativeHeight`
`protected CTPoint2D`	`simplePos`
`protected Boolean`	`simplePosAttr`
`protected CTSizeRelH`	`sizeRelH`
`protected CTSizeRelV`	`sizeRelV`
`protected CTWrapNone`	`wrapNone`
`protected CTWrapSquare`	`wrapSquare`
`protected CTWrapThrough`	`wrapThrough`
`protected CTWrapTight`	`wrapTight`
`protected CTWrapTopBottom`	`wrapTopAndBottom`

Constructor Summary

Constructors
Constructor and Description

Anchor()

Constructors
Constructor and Description
`Anchor()`

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.
`byte[]`	`getAnchorId()` Gets the value of the anchorId property.
`CTNonVisualGraphicFrameProperties`	`getCNvGraphicFramePr()` Gets the value of the cNvGraphicFramePr property.
`Long`	`getDistB()` Gets the value of the distB property.
`Long`	`getDistL()` Gets the value of the distL property.
`Long`	`getDistR()` Gets the value of the distR property.
`Long`	`getDistT()` Gets the value of the distT property.
`CTNonVisualDrawingProps`	`getDocPr()` Gets the value of the docPr property.
`byte[]`	`getEditId()` Gets the value of the editId property.
`CTEffectExtent`	`getEffectExtent()` Gets the value of the effectExtent property.
`CTPositiveSize2D`	`getExtent()` Gets the value of the extent property.
`Graphic`	`getGraphic()` Gets the value of the graphic property.
`Object`	`getParent()` Gets the parent object in the object tree representing the unmarshalled xml document.
`CTPosH`	`getPositionH()` Gets the value of the positionH property.
`CTPosV`	`getPositionV()` Gets the value of the positionV property.
`long`	`getRelativeHeight()` Gets the value of the relativeHeight property.
`CTPoint2D`	`getSimplePos()` Gets the value of the simplePos property.
`CTSizeRelH`	`getSizeRelH()` Gets the value of the sizeRelH property.
`CTSizeRelV`	`getSizeRelV()` Gets the value of the sizeRelV property.
`CTWrapNone`	`getWrapNone()` Gets the value of the wrapNone property.
`CTWrapSquare`	`getWrapSquare()` Gets the value of the wrapSquare property.
`CTWrapThrough`	`getWrapThrough()` Gets the value of the wrapThrough property.
`CTWrapTight`	`getWrapTight()` Gets the value of the wrapTight property.
`CTWrapTopBottom`	`getWrapTopAndBottom()` Gets the value of the wrapTopAndBottom property.
`boolean`	`isAllowOverlap()` Gets the value of the allowOverlap property.
`boolean`	`isBehindDoc()` Gets the value of the behindDoc property.
`Boolean`	`isHidden()` Gets the value of the hidden property.
`boolean`	`isLayoutInCell()` Gets the value of the layoutInCell property.
`boolean`	`isLocked()` Gets the value of the locked property.
`Boolean`	`isSimplePosAttr()` Gets the value of the simplePosAttr property.
`void`	`setAllowOverlap(boolean value)` Sets the value of the allowOverlap property.
`void`	`setAnchorId(byte[] value)` Sets the value of the anchorId property.
`void`	`setBehindDoc(boolean value)` Sets the value of the behindDoc property.
`void`	`setCNvGraphicFramePr(CTNonVisualGraphicFrameProperties value)` Sets the value of the cNvGraphicFramePr property.
`void`	`setDistB(Long value)` Sets the value of the distB property.
`void`	`setDistL(Long value)` Sets the value of the distL property.
`void`	`setDistR(Long value)` Sets the value of the distR property.
`void`	`setDistT(Long value)` Sets the value of the distT property.
`void`	`setDocPr(CTNonVisualDrawingProps value)` Sets the value of the docPr property.
`void`	`setEditId(byte[] value)` Sets the value of the editId property.
`void`	`setEffectExtent(CTEffectExtent value)` Sets the value of the effectExtent property.
`void`	`setExtent(CTPositiveSize2D value)` Sets the value of the extent property.
`void`	`setGraphic(Graphic value)` Sets the value of the graphic property.
`void`	`setHidden(Boolean value)` Sets the value of the hidden property.
`void`	`setLayoutInCell(boolean value)` Sets the value of the layoutInCell property.
`void`	`setLocked(boolean value)` Sets the value of the locked property.
`void`	`setParent(Object parent)`
`void`	`setPositionH(CTPosH value)` Sets the value of the positionH property.
`void`	`setPositionV(CTPosV value)` Sets the value of the positionV property.
`void`	`setRelativeHeight(long value)` Sets the value of the relativeHeight property.
`void`	`setSimplePos(CTPoint2D value)` Sets the value of the simplePos property.
`void`	`setSimplePosAttr(Boolean value)` Sets the value of the simplePosAttr property.
`void`	`setSizeRelH(CTSizeRelH value)` Sets the value of the sizeRelH property.
`void`	`setSizeRelV(CTSizeRelV value)` Sets the value of the sizeRelV property.
`void`	`setWrapNone(CTWrapNone value)` Sets the value of the wrapNone property.
`void`	`setWrapSquare(CTWrapSquare value)` Sets the value of the wrapSquare property.
`void`	`setWrapThrough(CTWrapThrough value)` Sets the value of the wrapThrough property.
`void`	`setWrapTight(CTWrapTight value)` Sets the value of the wrapTight property.
`void`	`setWrapTopAndBottom(CTWrapTopBottom value)` Sets the value of the wrapTopAndBottom property.

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

- Field Detail
  - simplePos
```
protected CTPoint2D simplePos
```
  - positionH
```
protected CTPosH positionH
```
  - positionV
```
protected CTPosV positionV
```
  - extent
```
protected CTPositiveSize2D extent
```
  - effectExtent
```
protected CTEffectExtent effectExtent
```
  - wrapNone
```
protected CTWrapNone wrapNone
```
  - wrapSquare
```
protected CTWrapSquare wrapSquare
```
  - wrapTight
```
protected CTWrapTight wrapTight
```
  - wrapThrough
```
protected CTWrapThrough wrapThrough
```
  - wrapTopAndBottom
```
protected CTWrapTopBottom wrapTopAndBottom
```
  - docPr
```
protected CTNonVisualDrawingProps docPr
```
  - cNvGraphicFramePr
```
protected CTNonVisualGraphicFrameProperties cNvGraphicFramePr
```
  - graphic
```
protected Graphic graphic
```
  - sizeRelH
```
protected CTSizeRelH sizeRelH
```
  - sizeRelV
```
protected CTSizeRelV sizeRelV
```
  - distT
```
protected Long distT
```
  - distB
```
protected Long distB
```
  - distL
```
protected Long distL
```
  - distR
```
protected Long distR
```
  - simplePosAttr
```
protected Boolean simplePosAttr
```
  - relativeHeight
```
protected long relativeHeight
```
  - behindDoc
```
protected boolean behindDoc
```
  - locked
```
protected boolean locked
```
  - layoutInCell
```
protected boolean layoutInCell
```
  - hidden
```
protected Boolean hidden
```
  - allowOverlap
```
protected boolean allowOverlap
```
  - anchorId
```
protected byte[] anchorId
```
  - editId
```
protected byte[] editId
```
- Constructor Detail
  - Anchor
```
public Anchor()
```
- Method Detail
  - getSimplePos
```
public CTPoint2D getSimplePos()
```
    Gets the value of the simplePos property.
    
    Returns:
    
    possible object is CTPoint2D
  - setSimplePos
```
public void setSimplePos(CTPoint2D value)
```
    Sets the value of the simplePos property.
    
    Parameters:
    
    value - allowed object is CTPoint2D
  - getPositionH
```
public CTPosH getPositionH()
```
    Gets the value of the positionH property.
    
    Returns:
    
    possible object is CTPosH
  - setPositionH
```
public void setPositionH(CTPosH value)
```
    Sets the value of the positionH property.
    
    Parameters:
    
    value - allowed object is CTPosH
  - getPositionV
```
public CTPosV getPositionV()
```
    Gets the value of the positionV property.
    
    Returns:
    
    possible object is CTPosV
  - setPositionV
```
public void setPositionV(CTPosV value)
```
    Sets the value of the positionV property.
    
    Parameters:
    
    value - allowed object is CTPosV
  - getExtent
```
public CTPositiveSize2D getExtent()
```
    Gets the value of the extent property.
    
    Returns:
    
    possible object is CTPositiveSize2D
  - setExtent
```
public void setExtent(CTPositiveSize2D value)
```
    Sets the value of the extent property.
    
    Parameters:
    
    value - allowed object is CTPositiveSize2D
  - getEffectExtent
```
public CTEffectExtent getEffectExtent()
```
    Gets the value of the effectExtent property.
    
    Returns:
    
    possible object is CTEffectExtent
  - setEffectExtent
```
public void setEffectExtent(CTEffectExtent value)
```
    Sets the value of the effectExtent property.
    
    Parameters:
    
    value - allowed object is CTEffectExtent
  - getWrapNone
```
public CTWrapNone getWrapNone()
```
    Gets the value of the wrapNone property.
    
    Returns:
    
    possible object is CTWrapNone
  - setWrapNone
```
public void setWrapNone(CTWrapNone value)
```
    Sets the value of the wrapNone property.
    
    Parameters:
    
    value - allowed object is CTWrapNone
  - getWrapSquare
```
public CTWrapSquare getWrapSquare()
```
    Gets the value of the wrapSquare property.
    
    Returns:
    
    possible object is CTWrapSquare
  - setWrapSquare
```
public void setWrapSquare(CTWrapSquare value)
```
    Sets the value of the wrapSquare property.
    
    Parameters:
    
    value - allowed object is CTWrapSquare
  - getWrapTight
```
public CTWrapTight getWrapTight()
```
    Gets the value of the wrapTight property.
    
    Returns:
    
    possible object is CTWrapTight
  - setWrapTight
```
public void setWrapTight(CTWrapTight value)
```
    Sets the value of the wrapTight property.
    
    Parameters:
    
    value - allowed object is CTWrapTight
  - getWrapThrough
```
public CTWrapThrough getWrapThrough()
```
    Gets the value of the wrapThrough property.
    
    Returns:
    
    possible object is CTWrapThrough
  - setWrapThrough
```
public void setWrapThrough(CTWrapThrough value)
```
    Sets the value of the wrapThrough property.
    
    Parameters:
    
    value - allowed object is CTWrapThrough
  - getWrapTopAndBottom
```
public CTWrapTopBottom getWrapTopAndBottom()
```
    Gets the value of the wrapTopAndBottom property.
    
    Returns:
    
    possible object is CTWrapTopBottom
  - setWrapTopAndBottom
```
public void setWrapTopAndBottom(CTWrapTopBottom value)
```
    Sets the value of the wrapTopAndBottom property.
    
    Parameters:
    
    value - allowed object is CTWrapTopBottom
  - getDocPr
```
public CTNonVisualDrawingProps getDocPr()
```
    Gets the value of the docPr property.
    
    Returns:
    
    possible object is CTNonVisualDrawingProps
  - setDocPr
```
public void setDocPr(CTNonVisualDrawingProps value)
```
    Sets the value of the docPr property.
    
    Parameters:
    
    value - allowed object is CTNonVisualDrawingProps
  - getCNvGraphicFramePr
```
public CTNonVisualGraphicFrameProperties getCNvGraphicFramePr()
```
    Gets the value of the cNvGraphicFramePr property.
    
    Returns:
    
    possible object is CTNonVisualGraphicFrameProperties
  - setCNvGraphicFramePr
```
public void setCNvGraphicFramePr(CTNonVisualGraphicFrameProperties value)
```
    Sets the value of the cNvGraphicFramePr property.
    
    Parameters:
    
    value - allowed object is CTNonVisualGraphicFrameProperties
  - getGraphic
```
public Graphic getGraphic()
```
    Gets the value of the graphic property.
    
    Returns:
    
    possible object is Graphic
  - setGraphic
```
public void setGraphic(Graphic value)
```
    Sets the value of the graphic property.
    
    Parameters:
    
    value - allowed object is Graphic
  - getSizeRelH
```
public CTSizeRelH getSizeRelH()
```
    Gets the value of the sizeRelH property.
    
    Returns:
    
    possible object is CTSizeRelH
  - setSizeRelH
```
public void setSizeRelH(CTSizeRelH value)
```
    Sets the value of the sizeRelH property.
    
    Parameters:
    
    value - allowed object is CTSizeRelH
  - getSizeRelV
```
public CTSizeRelV getSizeRelV()
```
    Gets the value of the sizeRelV property.
    
    Returns:
    
    possible object is CTSizeRelV
  - setSizeRelV
```
public void setSizeRelV(CTSizeRelV value)
```
    Sets the value of the sizeRelV property.
    
    Parameters:
    
    value - allowed object is CTSizeRelV
  - getDistT
```
public Long getDistT()
```
    Gets the value of the distT property.
    
    Returns:
    
    possible object is Long
  - setDistT
```
public void setDistT(Long value)
```
    Sets the value of the distT property.
    
    Parameters:
    
    value - allowed object is Long
  - getDistB
```
public Long getDistB()
```
    Gets the value of the distB property.
    
    Returns:
    
    possible object is Long
  - setDistB
```
public void setDistB(Long value)
```
    Sets the value of the distB property.
    
    Parameters:
    
    value - allowed object is Long
  - getDistL
```
public Long getDistL()
```
    Gets the value of the distL property.
    
    Returns:
    
    possible object is Long
  - setDistL
```
public void setDistL(Long value)
```
    Sets the value of the distL property.
    
    Parameters:
    
    value - allowed object is Long
  - getDistR
```
public Long getDistR()
```
    Gets the value of the distR property.
    
    Returns:
    
    possible object is Long
  - setDistR
```
public void setDistR(Long value)
```
    Sets the value of the distR property.
    
    Parameters:
    
    value - allowed object is Long
  - isSimplePosAttr
```
public Boolean isSimplePosAttr()
```
    Gets the value of the simplePosAttr property.
    
    Returns:
    
    possible object is Boolean
  - setSimplePosAttr
```
public void setSimplePosAttr(Boolean value)
```
    Sets the value of the simplePosAttr property.
    
    Parameters:
    
    value - allowed object is Boolean
  - getRelativeHeight
```
public long getRelativeHeight()
```
    Gets the value of the relativeHeight property.
  - setRelativeHeight
```
public void setRelativeHeight(long value)
```
    Sets the value of the relativeHeight property.
  - isBehindDoc
```
public boolean isBehindDoc()
```
    Gets the value of the behindDoc property.
  - setBehindDoc
```
public void setBehindDoc(boolean value)
```
    Sets the value of the behindDoc property.
  - isLocked
```
public boolean isLocked()
```
    Gets the value of the locked property.
  - setLocked
```
public void setLocked(boolean value)
```
    Sets the value of the locked property.
  - isLayoutInCell
```
public boolean isLayoutInCell()
```
    Gets the value of the layoutInCell property.
  - setLayoutInCell
```
public void setLayoutInCell(boolean value)
```
    Sets the value of the layoutInCell property.
  - isHidden
```
public Boolean isHidden()
```
    Gets the value of the hidden property.
    
    Returns:
    
    possible object is Boolean
  - setHidden
```
public void setHidden(Boolean value)
```
    Sets the value of the hidden property.
    
    Parameters:
    
    value - allowed object is Boolean
  - isAllowOverlap
```
public boolean isAllowOverlap()
```
    Gets the value of the allowOverlap property.
  - setAllowOverlap
```
public void setAllowOverlap(boolean value)
```
    Sets the value of the allowOverlap property.
  - getAnchorId
```
public byte[] getAnchorId()
```
    Gets the value of the anchorId property.
    
    Returns:
    
    possible object is String
  - setAnchorId
```
public void setAnchorId(byte[] value)
```
    Sets the value of the anchorId property.
    
    Parameters:
    
    value - allowed object is String
  - getEditId
```
public byte[] getEditId()
```
    Gets the value of the editId property.
    
    Returns:
    
    possible object is String
  - setEditId
```
public void setEditId(byte[] value)
```
    Sets the value of the editId property.
    
    Parameters:
    
    value - allowed object is String
  - 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 Anchor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

simplePos

positionH

positionV

extent

effectExtent

wrapNone

wrapSquare

wrapTight

wrapThrough

wrapTopAndBottom

docPr

cNvGraphicFramePr

graphic

sizeRelH

sizeRelV

distT

distB

distL

distR

simplePosAttr

relativeHeight

behindDoc

locked

layoutInCell

hidden

allowOverlap

anchorId

editId

Constructor Detail

Anchor

Method Detail

getSimplePos

setSimplePos

getPositionH

setPositionH

getPositionV

setPositionV

getExtent

setExtent

getEffectExtent

setEffectExtent

getWrapNone

setWrapNone

getWrapSquare

setWrapSquare

getWrapTight

setWrapTight

getWrapThrough

setWrapThrough

getWrapTopAndBottom

setWrapTopAndBottom

getDocPr

setDocPr

getCNvGraphicFramePr

setCNvGraphicFramePr

getGraphic

setGraphic

getSizeRelH

setSizeRelH

getSizeRelV

setSizeRelV

getDistT

setDistT

getDistB

setDistB

getDistL

setDistL

getDistR

setDistR

isSimplePosAttr

setSimplePosAttr

getRelativeHeight

setRelativeHeight

isBehindDoc