java.lang.Object

org.apache.poi.xssf.usermodel.XSSFAnchor

org.apache.poi.xssf.usermodel.XSSFClientAnchor

All Implemented Interfaces:: ChildAnchor, ClientAnchor

public class XSSFClientAnchor extends XSSFAnchor implements ClientAnchor

A client anchor is attached to an excel worksheet. It anchors against:

A fixed position and fixed size
A position relative to a cell (top-left) and a fixed size
A position relative to a cell (top-left) and sized relative to another cell (bottom right)

which method is used is determined by the ClientAnchor.AnchorType.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.poi.ss.usermodel.ClientAnchor
ClientAnchor.AnchorType
Constructor Summary

Constructors

Constructor

Description

XSSFClientAnchor()

Creates a new client anchor and defaults all the anchor positions to 0.

XSSFClientAnchor(int dx1, int dy1, int dx2, int dy2, int col1, int row1, int col2, int row2)

Creates a new client anchor and sets the top-left and bottom-right coordinates of the anchor by cell references and offsets.
Method Summary

Modifier and Type

Method

Description

boolean

equals(Object o)

ClientAnchor.AnchorType

getAnchorType()

Gets the anchor type Changed from returning an int to an enum in POI 3.14 beta 1.

short

getCol1()

Returns the column (0 based) of the first cell, or -1 if there is no top-left anchor cell.

short

getCol2()

Returns the column (0 based) of the second cell, or -1 if there is no bottom-right anchor cell.

int

getDx1()

Returns the x coordinate within the first cell.

int

getDx2()

Returns the x coordinate within the second cell Note - XSSF and HSSF have a slightly different coordinate system, values in XSSF are larger by a factor of Units.EMU_PER_PIXEL

int

getDy1()

Returns the y coordinate within the first cell Note - XSSF and HSSF have a slightly different coordinate system, values in XSSF are larger by a factor of Units.EMU_PER_PIXEL

int

getDy2()

Sets the y coordinate within the second cell Note - XSSF and HSSF have a slightly different coordinate system, values in XSSF are larger by a factor of Units.EMU_PER_PIXEL

CTMarker

getFrom()

Return starting anchor point

CTPoint2D

getPosition()

int

getRow1()

Returns the row (0 based) of the first cell, or -1 if there is no bottom-right anchor cell.

int

getRow2()

Returns the row (0 based) of the second cell, or -1 if there is no bottom-right anchor cell.

CTPositiveSize2D

getSize()

CTMarker

getTo()

Return ending anchor point

int

hashCode()

boolean

isSet()

void

setAnchorType(ClientAnchor.AnchorType anchorType)

Sets the anchor type

void

setCol1(int col1)

Sets the column (0 based) of the first cell.

void

setCol2(int col2)

Returns the column (0 based) of the second cell.

void

setDx1(int dx1)

Sets the x coordinate within the first cell Note - XSSF and HSSF have a slightly different coordinate system, values in XSSF are larger by a factor of Units.EMU_PER_PIXEL

void

setDx2(int dx2)

Sets the x coordinate within the second cell Note - XSSF and HSSF have a slightly different coordinate system, values in XSSF are larger by a factor of Units.EMU_PER_PIXEL

void

setDy1(int dy1)

Sets the y coordinate within the first cell Note - XSSF and HSSF have a slightly different coordinate system, values in XSSF are larger by a factor of Units.EMU_PER_PIXEL

void

setDy2(int dy2)

Sets the y coordinate within the second cell Note - XSSF and HSSF have a slightly different coordinate system, values in XSSF are larger by a factor of Units.EMU_PER_PIXEL

void

setPosition(CTPoint2D position)

Sets the top-left absolute position of the object.

void

setRow1(int row1)

Returns the row (0 based) of the first cell.

void

setRow2(int row2)

Returns the row (0 based) of the first cell.

void

setSize(CTPositiveSize2D size)

Sets the size of the object.

String

toString()

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Constructor Details
- XSSFClientAnchor
  
  public XSSFClientAnchor()
  
  Creates a new client anchor and defaults all the anchor positions to 0. Sets the type to ClientAnchor.AnchorType.MOVE_AND_RESIZE relative to cell range A1:A1.
- XSSFClientAnchor
  
  public XSSFClientAnchor(int dx1, int dy1, int dx2, int dy2, int col1, int row1, int col2, int row2)
  
  Creates a new client anchor and sets the top-left and bottom-right coordinates of the anchor by cell references and offsets. Sets the type to ClientAnchor.AnchorType.MOVE_AND_RESIZE.
  
  Parameters:
  
  dx1 - the x coordinate within the first cell.
  
  dy1 - the y coordinate within the first cell.
  
  dx2 - the x coordinate within the second cell.
  
  dy2 - the y coordinate within the second cell.
  
  col1 - the column (0 based) of the first cell.
  
  row1 - the row (0 based) of the first cell.
  
  col2 - the column (0 based) of the second cell.
  
  row2 - the row (0 based) of the second cell.
Method Details
- getCol1
  
  public short getCol1()
  
  Description copied from interface: ClientAnchor
  
  Returns the column (0 based) of the first cell, or -1 if there is no top-left anchor cell. This is the case for absolute positioning ClientAnchor.AnchorType.MOVE_AND_RESIZE
  
  Specified by:
  
  getCol1 in interface ClientAnchor
  
  Returns:
  
  0-based column of the first cell or -1 if none.
- setCol1
  
  public void setCol1(int col1)
  
  Description copied from interface: ClientAnchor
  
  Sets the column (0 based) of the first cell.
  
  Specified by:
  
  setCol1 in interface ClientAnchor
  
  Parameters:
  
  col1 - 0-based column of the first cell.
  
  Throws:
  
  NullPointerException - if cell1 is null (fixed position)
- getCol2
  
  public short getCol2()
  
  Description copied from interface: ClientAnchor
  
  Returns the column (0 based) of the second cell, or -1 if there is no bottom-right anchor cell. This is the case for absolute positioning (ClientAnchor.AnchorType.DONT_MOVE_AND_RESIZE) and absolute sizing (ClientAnchor.AnchorType.MOVE_DONT_RESIZE.
  
  Specified by:
  
  getCol2 in interface ClientAnchor
  
  Returns:
  
  0-based column of the second cell or -1 if none.
- setCol2
  
  public void setCol2(int col2)
  
  Description copied from interface: ClientAnchor
  
  Returns the column (0 based) of the second cell.
  
  Specified by:
  
  setCol2 in interface ClientAnchor
  
  Parameters:
  
  col2 - 0-based column of the second cell.
  
  Throws:
  
  NullPointerException - if cell2 is null (fixed size)
- getRow1
  
  public int getRow1()
  
  Description copied from interface: ClientAnchor
  
  Returns the row (0 based) of the first cell, or -1 if there is no bottom-right anchor cell. This is the case for absolute positioning (ClientAnchor.AnchorType.DONT_MOVE_AND_RESIZE).
  
  Specified by:
  
  getRow1 in interface ClientAnchor
  
  Returns:
  
  0-based row of the first cell or -1 if none.
- setRow1
  
  public void setRow1(int row1)
  
  Description copied from interface: ClientAnchor
  
  Returns the row (0 based) of the first cell.
  
  Specified by:
  
  setRow1 in interface ClientAnchor
  
  Parameters:
  
  row1 - 0-based row of the first cell.
  
  Throws:
  
  NullPointerException - if cell1 is null (fixed position)
- getRow2
  
  public int getRow2()
  
  Description copied from interface: ClientAnchor
  
  Returns the row (0 based) of the second cell, or -1 if there is no bottom-right anchor cell. This is the case for absolute positioning (ClientAnchor.AnchorType.DONT_MOVE_AND_RESIZE) and absolute sizing (ClientAnchor.AnchorType.MOVE_DONT_RESIZE.
  
  Specified by:
  
  getRow2 in interface ClientAnchor
  
  Returns:
  
  0-based row of the second cell or -1 if none.
- setRow2
  
  public void setRow2(int row2)
  
  Description copied from interface: ClientAnchor
  
  Returns the row (0 based) of the first cell.
  
  Specified by:
  
  setRow2 in interface ClientAnchor
  
  Parameters:
  
  row2 - 0-based row of the first cell.
  
  Throws:
  
  NullPointerException - if cell2 is null (fixed size)
- getDx1
  
  public int getDx1()
  
  Description copied from interface: ClientAnchor
  
  Returns the x coordinate within the first cell. Note - XSSF and HSSF have a slightly different coordinate system, values in XSSF are larger by a factor of Units.EMU_PER_PIXEL
  
  Specified by:
  
  getDx1 in interface ChildAnchor
  
  Specified by:
  
  getDx1 in interface ClientAnchor
  
  Returns:
  
  the x coordinate within the first cell
- setDx1
  
  public void setDx1(int dx1)
  
  Description copied from interface: ClientAnchor
  
  Sets the x coordinate within the first cell Note - XSSF and HSSF have a slightly different coordinate system, values in XSSF are larger by a factor of Units.EMU_PER_PIXEL
  Specified by:
  
  setDx1 in interface ChildAnchor
  
  Specified by:
  
  setDx1 in interface ClientAnchor
  
  Parameters:
  
  dx1 - the x coordinate within the first cell
  
  Throws:
  
  NullPointerException - if cell1 is null (fixed position)
  
  See Also:
  
  ChildAnchor.setDx1(int)
- getDy1
  
  public int getDy1()
  
  Description copied from interface: ClientAnchor
  
  Returns the y coordinate within the first cell Note - XSSF and HSSF have a slightly different coordinate system, values in XSSF are larger by a factor of Units.EMU_PER_PIXEL
  
  Specified by:
  
  getDy1 in interface ChildAnchor
  
  Specified by:
  
  getDy1 in interface ClientAnchor
  
  Returns:
  
  the y coordinate within the first cell
- setDy1
  
  public void setDy1(int dy1)
  
  Description copied from interface: ClientAnchor
  
  Sets the y coordinate within the first cell Note - XSSF and HSSF have a slightly different coordinate system, values in XSSF are larger by a factor of Units.EMU_PER_PIXEL
  Specified by:
  
  setDy1 in interface ChildAnchor
  
  Specified by:
  
  setDy1 in interface ClientAnchor
  
  Parameters:
  
  dy1 - the y coordinate within the first cell
  
  Throws:
  
  NullPointerException - if cell1 is null (fixed position)
  
  See Also:
  
  ChildAnchor.setDy1(int)
- getDy2
  
  public int getDy2()
  
  Description copied from interface: ClientAnchor
  
  Sets the y coordinate within the second cell Note - XSSF and HSSF have a slightly different coordinate system, values in XSSF are larger by a factor of Units.EMU_PER_PIXEL
  
  Specified by:
  
  getDy2 in interface ChildAnchor
  
  Specified by:
  
  getDy2 in interface ClientAnchor
  
  Returns:
  
  the y coordinate within the second cell
- setDy2
  
  public void setDy2(int dy2)
  
  Description copied from interface: ClientAnchor
  
  Sets the y coordinate within the second cell Note - XSSF and HSSF have a slightly different coordinate system, values in XSSF are larger by a factor of Units.EMU_PER_PIXEL
  Specified by:
  
  setDy2 in interface ChildAnchor
  
  Specified by:
  
  setDy2 in interface ClientAnchor
  
  Parameters:
  
  dy2 - the y coordinate within the second cell
  
  Throws:
  
  NullPointerException - if cell2 is null (fixed size)
  
  See Also:
  
  ChildAnchor.setDy2(int)
- getDx2
  
  public int getDx2()
  
  Description copied from interface: ClientAnchor
  
  Returns the x coordinate within the second cell Note - XSSF and HSSF have a slightly different coordinate system, values in XSSF are larger by a factor of Units.EMU_PER_PIXEL
  
  Specified by:
  
  getDx2 in interface ChildAnchor
  
  Specified by:
  
  getDx2 in interface ClientAnchor
  
  Returns:
  
  the x coordinate within the second cell
- setDx2
  
  public void setDx2(int dx2)
  
  Description copied from interface: ClientAnchor
  
  Sets the x coordinate within the second cell Note - XSSF and HSSF have a slightly different coordinate system, values in XSSF are larger by a factor of Units.EMU_PER_PIXEL
  Specified by:
  
  setDx2 in interface ChildAnchor
  
  Specified by:
  
  setDx2 in interface ClientAnchor
  
  Parameters:
  
  dx2 - the x coordinate within the second cell
  
  Throws:
  
  NullPointerException - if cell2 is null (fixed size)
  
  See Also:
  
  ChildAnchor.setDx2(int)
- equals
  
  public boolean equals(Object o)
  
  Overrides:
  
  equals in class Object
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class Object
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object
- getFrom
  
  @Internal public CTMarker getFrom()
  
  Return starting anchor point
  
  Returns:
  
  starting anchor point
- getTo
  
  @Internal public CTMarker getTo()
  
  Return ending anchor point
  
  Returns:
  
  ending anchor point
- getPosition
  
  public CTPoint2D getPosition()
  
  Returns:
  
  absolute top-left position, or null if position is determined from the "from" cell
  
  Since:
  
  POI 3.17 beta 1
- setPosition
  
  public void setPosition(CTPoint2D position)
  
  Sets the top-left absolute position of the object. To use this, "from" must be set to null.
  
  Since:
  
  POI 3.17 beta 1
- getSize
  
  public CTPositiveSize2D getSize()
  
  Returns:
  
  size or null, if size is determined from the to and from cells
  
  Since:
  
  POI 3.17 beta 1
- setSize
  
  public void setSize(CTPositiveSize2D size)
  
  Sets the size of the object. To use this, "to" must be set to null.
  
  Since:
  
  POI 3.17 beta 1
- setAnchorType
  
  public void setAnchorType(ClientAnchor.AnchorType anchorType)
  
  Sets the anchor type
  
  Specified by:
  
  setAnchorType in interface ClientAnchor
  
  Parameters:
  
  anchorType - the anchor type to set
  
  Since:
  
  POI 3.14
- getAnchorType
  
  public ClientAnchor.AnchorType getAnchorType()
  
  Gets the anchor type Changed from returning an int to an enum in POI 3.14 beta 1.
  
  Specified by:
  
  getAnchorType in interface ClientAnchor
  
  Returns:
  
  the anchor type
- isSet
  
  public boolean isSet()

Class XSSFClientAnchor

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.poi.ss.usermodel.ClientAnchor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

XSSFClientAnchor

XSSFClientAnchor

Method Details

getCol1

setCol1

getCol2

setCol2

getRow1

setRow1

getRow2

setRow2

getDx1

setDx1

getDy1

setDy1

getDy2

setDy2

getDx2

setDx2

equals

hashCode

toString

getFrom

getTo

getPosition

setPosition

getSize

setSize

setAnchorType

getAnchorType

isSet