Documentation of 'org.apache.poi.xssf.usermodel.XSSFClientAnchor' Java class
XSSFClientAnchor
Skip navigation links
org.apache.poi.xssf.usermodel

Class XSSFClientAnchor

  • All Implemented Interfaces:
    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.

    • Constructor Summary

      Constructors 
      Constructor and 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.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      boolean equals(java.lang.Object o) 
      int getAnchorType()
      Gets the anchor type
      short getCol1()
      Returns the column (0 based) of the first cell.
      short getCol2()
      Returns the column (0 based) of the second 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
      int getRow1()
      Returns the row (0 based) of the first cell.
      int getRow2()
      Returns the row (0 based) of the second cell.
      org.openxmlformats.schemas.drawingml.x2006.spreadsheetDrawing.CTMarker getTo()
      Return ending anchor point
      int hashCode() 
      boolean isSet() 
      void setAnchorType(int 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 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.
      java.lang.String toString() 

      • Methods inherited from class java.lang.Object

        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.

    • Method Detail

      • getCol1

        public short getCol1()
        Description copied from interface: ClientAnchor
        Returns the column (0 based) of the first cell.
        Specified by:
        getCol1 in interface ClientAnchor
        Returns:
        0-based column of the first cell.

      • 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.

      • getCol2

        public short getCol2()
        Description copied from interface: ClientAnchor
        Returns the column (0 based) of the second cell.
        Specified by:
        getCol2 in interface ClientAnchor
        Returns:
        0-based column of the second cell.

      • 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.

      • getRow1

        public int getRow1()
        Description copied from interface: ClientAnchor
        Returns the row (0 based) of the first cell.
        Specified by:
        getRow1 in interface ClientAnchor
        Returns:
        0-based row of the first cell.

      • 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.

      • getRow2

        public int getRow2()
        Description copied from interface: ClientAnchor
        Returns the row (0 based) of the second cell.
        Specified by:
        getRow2 in interface ClientAnchor
        Returns:
        0-based row of the second cell.

      • 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.

      • 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 ClientAnchor
        Specified by:
        getDx1 in class XSSFAnchor
        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 ClientAnchor
        Specified by:
        setDx1 in class XSSFAnchor
        Parameters:
        dx1 - the x coordinate within the first cell

      • 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 ClientAnchor
        Specified by:
        getDy1 in class XSSFAnchor
        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 ClientAnchor
        Specified by:
        setDy1 in class XSSFAnchor
        Parameters:
        dy1 - the y coordinate within the first cell

      • 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 ClientAnchor
        Specified by:
        getDy2 in class XSSFAnchor
        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 ClientAnchor
        Specified by:
        setDy2 in class XSSFAnchor
        Parameters:
        dy2 - the y coordinate within the second cell

      • 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 ClientAnchor
        Specified by:
        getDx2 in class XSSFAnchor
        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 ClientAnchor
        Specified by:
        setDx2 in class XSSFAnchor
        Parameters:
        dx2 - the x coordinate within the second cell

      • 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

      • getTo

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

      • isSet

        public boolean isSet()
Skip navigation links

DataMelt 3.0 © DataMelt by jWork.ORG

You see the box below because you did not login.