Overview  Package   Class  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
  extended by org.apache.poi.xssf.usermodel.XSSFAnchor
      extended by org.apache.poi.xssf.usermodel.XSSFClientAnchor
All Implemented Interfaces:
ChildAnchor, ClientAnchor
public final class XSSFClientAnchor
extends XSSFAnchor
implements ClientAnchor

A client anchor is attached to an excel worksheet. It anchors against top-left and bottom-right cells.

Nested Class Summary
 
Nested classes/interfaces inherited from interface org.apache.poi.ss.usermodel.ClientAnchor
ClientAnchor.AnchorType
 
Field Summary
 
Fields inherited from interface org.apache.poi.ss.usermodel.ClientAnchor
DONT_MOVE_AND_RESIZE, MOVE_AND_RESIZE, MOVE_DONT_RESIZE
 
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
  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.
 
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()
           
 short getCol2()
           
 int getDx1()
           
 int getDx2()
           
 int getDy1()
           
 int getDy2()
           
 org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTMarker getFrom()
          Return starting anchor point
 int getRow1()
           
 int getRow2()
           
 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 setAnchorType(int anchorType)
          Deprecated. POI 3.15. Use ClientAnchor.setAnchorType(AnchorType) instead
 void setCol1(int col1)
           
 void setCol2(int col2)
           
 void setDx1(int dx1)
           
 void setDx2(int dx2)
           
 void setDy1(int dy1)
           
 void setDy2(int dy2)
           
protected  void setFrom(org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTMarker from)
           
 void setRow1(int row1)
           
 void setRow2(int row2)
           
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.

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.

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

Parameters:
cell1 - starting anchor point
cell2 - ending anchor point
Method Detail

getCol1

public short getCol1()
Specified by:
getCol1 in interface ClientAnchor

setCol1

public void setCol1(int col1)
Specified by:
setCol1 in interface ClientAnchor

getCol2

public short getCol2()
Specified by:
getCol2 in interface ClientAnchor

setCol2

public void setCol2(int col2)
Specified by:
setCol2 in interface ClientAnchor

getRow1

public int getRow1()
Specified by:
getRow1 in interface ClientAnchor

setRow1

public void setRow1(int row1)
Specified by:
setRow1 in interface ClientAnchor

getRow2

public int getRow2()
Specified by:
getRow2 in interface ClientAnchor

setRow2

public void setRow2(int row2)
Specified by:
setRow2 in interface ClientAnchor

getDx1

public int getDx1()
Specified by:
getDx1 in interface ChildAnchor
Specified by:
getDx1 in interface ClientAnchor

setDx1

public void setDx1(int dx1)
Specified by:
setDx1 in interface ChildAnchor
Specified by:
setDx1 in interface ClientAnchor

getDy1

public int getDy1()
Specified by:
getDy1 in interface ChildAnchor
Specified by:
getDy1 in interface ClientAnchor

setDy1

public void setDy1(int dy1)
Specified by:
setDy1 in interface ChildAnchor
Specified by:
setDy1 in interface ClientAnchor

getDy2

public int getDy2()
Specified by:
getDy2 in interface ChildAnchor
Specified by:
getDy2 in interface ClientAnchor

setDy2

public void setDy2(int dy2)
Specified by:
setDy2 in interface ChildAnchor
Specified by:
setDy2 in interface ClientAnchor

getDx2

public int getDx2()
Specified by:
getDx2 in interface ChildAnchor
Specified by:
getDx2 in interface ClientAnchor

setDx2

public void setDx2(int dx2)
Specified by:
setDx2 in interface ChildAnchor
Specified by:
setDx2 in interface ClientAnchor

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getFrom

@Internal
public org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTMarker getFrom()
Return starting anchor point

Returns:
starting anchor point

setFrom

protected void setFrom(org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTMarker from)

getTo

@Internal
public org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTMarker getTo()
Return ending anchor point

Returns:
ending anchor point

setTo

protected void setTo(org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTMarker to)

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

setAnchorType

@Removal(version="3.17")
public void setAnchorType(int anchorType)
Deprecated. POI 3.15. Use ClientAnchor.setAnchorType(AnchorType) instead

Sets the anchor type

Specified by:
setAnchorType in interface ClientAnchor
Parameters:
anchorType - the anchor type to set

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()
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD