XSSFClientAnchor (POI API Documentation)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.poi.xssf.usermodel
Class XSSFClientAnchor

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
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
	`XSSFClientAnchor()` Creates a new client anchor and defaults all the anchor positions to 0.
`protected`	`XSSFClientAnchor(org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTMarker cell1, org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTMarker cell2)` Create XSSFClientAnchor from existing xml beans, sized and positioned relative to a pair of cells.
	`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.
`protected`	`XSSFClientAnchor(XSSFSheet sheet, org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTMarker cell1, org.openxmlformats.schemas.drawingml.x2006.main.CTPositiveSize2D size)` Create XSSFClientAnchor from existing xml beans, sized and positioned relative to a pair of cells.
`protected`	`XSSFClientAnchor(XSSFSheet sheet, org.openxmlformats.schemas.drawingml.x2006.main.CTPoint2D position, org.openxmlformats.schemas.drawingml.x2006.main.CTPositiveSize2D size)` Create XSSFClientAnchor from existing xml beans, sized and positioned relative to a pair of cells.

Method Summary
`boolean`	`equals(java.lang.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`
`org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTMarker`	`getFrom()` Return starting anchor point
`org.openxmlformats.schemas.drawingml.x2006.main.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.
`org.openxmlformats.schemas.drawingml.x2006.main.CTPositiveSize2D`	`getSize()`
`org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.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`
`protected void`	`setFrom(org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTMarker from)`
`void`	`setPosition(org.openxmlformats.schemas.drawingml.x2006.main.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(org.openxmlformats.schemas.drawingml.x2006.main.CTPositiveSize2D size)` Sets the size of the object.
`protected void`	`setTo(org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTMarker to)`
`java.lang.String`	`toString()`

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

Constructor Detail

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.

XSSFClientAnchor

protected XSSFClientAnchor(org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTMarker cell1,
                           org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTMarker cell2)

Create XSSFClientAnchor from existing xml beans, sized and positioned relative to a pair of cells. Sets the type to ClientAnchor.AnchorType.MOVE_AND_RESIZE.

Parameters:: cell1 - starting anchor point; cell2 - ending anchor point

XSSFClientAnchor

protected XSSFClientAnchor(XSSFSheet sheet,
                           org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTMarker cell1,
                           org.openxmlformats.schemas.drawingml.x2006.main.CTPositiveSize2D size)

Create XSSFClientAnchor from existing xml beans, sized and positioned relative to a pair of cells. Sets the type to ClientAnchor.AnchorType.MOVE_DONT_RESIZE.

Parameters:: sheet - needed to calculate ending point based on column/row sizes; cell1 - starting anchor point; size - object size, to calculate ending anchor point

XSSFClientAnchor

protected XSSFClientAnchor(XSSFSheet sheet,
                           org.openxmlformats.schemas.drawingml.x2006.main.CTPoint2D position,
                           org.openxmlformats.schemas.drawingml.x2006.main.CTPositiveSize2D size)

Create XSSFClientAnchor from existing xml beans, sized and positioned relative to a pair of cells. Sets the type to ClientAnchor.AnchorType.DONT_MOVE_AND_RESIZE.

Parameters:: sheet - needed to calculate starting and ending points based on column/row sizes; position - starting absolute position; size - object size, to calculate ending position

Method Detail