public final class ExcelDrawingPosition extends Object
ExcelDrawing
(picture, chart, etc.) in the worksheet.Modifier and Type | Method and Description |
---|---|
AnchorCell |
getFrom()
Gets the anchor cell which the
ExcelDrawing (picture, chart, etc.) spans from. |
double |
getHeight()
Gets the height (in points) of the
ExcelDrawing (picture, chart, etc.). |
double |
getHeight(LengthUnit unit)
Gets the height of the
ExcelDrawing (picture, chart, etc.). |
double |
getLeft()
Gets the distance (in points) of the left edge of the
ExcelDrawing (picture, chart, etc.) from the left edge of the worksheet. |
double |
getLeft(LengthUnit unit)
Gets the distance of the left edge of the
ExcelDrawing (picture, chart, etc.) from the left edge of the worksheet. |
PositioningMode |
getMode()
Gets the positioning mode of the
ExcelDrawing (picture, chart, etc.). |
AnchorCell |
getTo()
Gets the anchor cell which the
ExcelDrawing (picture, chart, etc.) spans to. |
double |
getTop()
Gets the distance (in points) of the top edge of the
ExcelDrawing (picture, chart, etc.) from the top edge of the worksheet. |
double |
getTop(LengthUnit unit)
Gets the distance of the top edge of the
ExcelDrawing (picture, chart, etc.) from the top edge of the worksheet. |
double |
getWidth()
Gets the width (in points) of the
ExcelDrawing (picture, chart, etc.). |
double |
getWidth(LengthUnit unit)
Gets the width of the
ExcelDrawing (picture, chart, etc.). |
void |
setFrom(AnchorCell value)
Sets the anchor cell which the
ExcelDrawing (picture, chart, etc.) spans from. |
void |
setHeight(double value)
Sets the height (in points) of the
ExcelDrawing (picture, chart, etc.). |
void |
setHeight(double value,
LengthUnit unit)
Sets the height of the
ExcelDrawing (picture, chart, etc.). |
void |
setLeft(double value)
Sets the distance (in points) of the left edge of the
ExcelDrawing (picture, chart, etc.) from the left edge of the worksheet. |
void |
setLeft(double value,
LengthUnit unit)
Sets the distance of the left edge of the
ExcelDrawing (picture, chart, etc.) from the left edge of the worksheet. |
void |
setMode(PositioningMode value)
Sets the positioning mode of the
ExcelDrawing (picture, chart, etc.). |
void |
setTo(AnchorCell value)
Sets the anchor cell which the
ExcelDrawing (picture, chart, etc.) spans to. |
void |
setTop(double value)
Sets the distance (in points) of the top edge of the
ExcelDrawing (picture, chart, etc.) from the top edge of the worksheet. |
void |
setTop(double value,
LengthUnit unit)
Sets the distance of the top edge of the
ExcelDrawing (picture, chart, etc.) from the top edge of the worksheet. |
void |
setWidth(double value)
Sets the width (in points) of the
ExcelDrawing (picture, chart, etc.). |
void |
setWidth(double value,
LengthUnit unit)
Sets the width of the
ExcelDrawing (picture, chart, etc.). |
String |
toString()
Returns a
String that represents this ExcelDrawingPosition instance. |
public AnchorCell getFrom()
ExcelDrawing
(picture, chart, etc.) spans from.
If ExcelDrawing.getPosition()
.getMode()
is PositioningMode.FREE_FLOATING
, then:
getter returns new instance of AnchorCell
for every request and changing that instance won't affect on the position of the drawing (picture, chart, etc.).
ExcelDrawing
(picture, chart, etc.) spans from.public double getHeight()
ExcelDrawing
(picture, chart, etc.).
If ExcelDrawing.getPosition()
.getMode()
is PositioningMode.MOVE_AND_SIZE
, then:
getter calculates the height for every request by using height
s of rows in the worksheet.
ExcelDrawing
(picture, chart, etc.).public double getHeight(LengthUnit unit)
ExcelDrawing
(picture, chart, etc.).
If ExcelDrawing.getPosition()
.getMode()
is PositioningMode.MOVE_AND_SIZE
, then:
getter calculates the height for every request by using height
s of rows in the worksheet.
unit
- The length unit of the returned value.ExcelDrawing
(picture, chart, etc.).public double getLeft()
ExcelDrawing
(picture, chart, etc.) from the left edge of the worksheet.
If ExcelDrawing.getPosition()
.getMode()
is PositioningMode.MOVE
or PositioningMode.MOVE_AND_SIZE
, then:
getter calculates the distance from the left edge of the worksheet for every request by using width
s of columns in the worksheet.
ExcelDrawing
(picture, chart, etc.) from the left edge of the worksheet.public double getLeft(LengthUnit unit)
ExcelDrawing
(picture, chart, etc.) from the left edge of the worksheet.
If ExcelDrawing.getPosition()
.getMode()
is PositioningMode.MOVE
or PositioningMode.MOVE_AND_SIZE
, then:
getter calculates the distance from the left edge of the worksheet for every request by using width
s of columns in the worksheet.
unit
- The length unit of the returned value.ExcelDrawing
(picture, chart, etc.) from the left edge of the worksheet.public PositioningMode getMode()
ExcelDrawing
(picture, chart, etc.).ExcelDrawing
(picture, chart, etc.).public AnchorCell getTo()
ExcelDrawing
(picture, chart, etc.) spans to.
If ExcelDrawing.getPosition()
.getMode()
is PositioningMode.FREE_FLOATING
or PositioningMode.MOVE
, then:
getter returns new instance of AnchorCell
for every request and changing that instance won't affect on the position of the drawing (picture, chart, etc.).
ExcelDrawing
(picture, chart, etc.) spans to.public double getTop()
ExcelDrawing
(picture, chart, etc.) from the top edge of the worksheet.
If ExcelDrawing.getPosition()
.getMode()
is PositioningMode.MOVE
or PositioningMode.MOVE_AND_SIZE
, then:
getter calculates the distance from the top edge of the worksheet for every request by using height
s of rows in the worksheet.
ExcelDrawing
(picture, chart, etc.) from the top edge of the worksheet.public double getTop(LengthUnit unit)
ExcelDrawing
(picture, chart, etc.) from the top edge of the worksheet.
If ExcelDrawing.getPosition()
.getMode()
is PositioningMode.MOVE
or PositioningMode.MOVE_AND_SIZE
, then:
getter calculates the distance from the top edge of the worksheet for every request by using height
s of rows in the worksheet.
unit
- The length unit of the returned value.ExcelDrawing
(picture, chart, etc.) from the top edge of the worksheet.public double getWidth()
ExcelDrawing
(picture, chart, etc.).
If ExcelDrawing.getPosition()
.getMode()
is PositioningMode.MOVE_AND_SIZE
, then:
getter calculates the width for every request by using width
s of columns in the worksheet.
ExcelDrawing
(picture, chart, etc.).public double getWidth(LengthUnit unit)
ExcelDrawing
(picture, chart, etc.).
If ExcelDrawing.getPosition()
.getMode()
is PositioningMode.MOVE_AND_SIZE
, then:
getter calculates the width for every request by using width
s of columns in the worksheet.
unit
- The length unit of the returned value.ExcelDrawing
(picture, chart, etc.).public void setFrom(AnchorCell value)
ExcelDrawing
(picture, chart, etc.) spans from.
If ExcelDrawing.getPosition()
.getMode()
is PositioningMode.FREE_FLOATING
, then:
setter will internally use setLeft(double)
and setTop(double)
methods, which are calculated by using width
s and height
s of columns and rows in the worksheet.
value
- The anchor cell which the ExcelDrawing
(picture, chart, etc.) spans from.public void setHeight(double value)
ExcelDrawing
(picture, chart, etc.).
If ExcelDrawing.getPosition()
.getMode()
is PositioningMode.MOVE_AND_SIZE
, then:
setter will internally use setTo(com.gembox.spreadsheet.AnchorCell)
method.
value
- The height (in points) of the ExcelDrawing
(picture, chart, etc.).public void setHeight(double value, LengthUnit unit)
ExcelDrawing
(picture, chart, etc.).
If ExcelDrawing.getPosition()
.getMode()
is PositioningMode.MOVE_AND_SIZE
, then:
setter will internally use setTo(com.gembox.spreadsheet.AnchorCell)
method.
value
- The value.unit
- The length unit of the value
parameter.public void setLeft(double value)
ExcelDrawing
(picture, chart, etc.) from the left edge of the worksheet.
If ExcelDrawing.getPosition()
.getMode()
is PositioningMode.MOVE
or PositioningMode.MOVE_AND_SIZE
, then:
setter will internally use setFrom(com.gembox.spreadsheet.AnchorCell)
method.
value
- The distance (in points) of the left edge of the ExcelDrawing
(picture, chart, etc.) from the left edge of the worksheet.public void setLeft(double value, LengthUnit unit)
ExcelDrawing
(picture, chart, etc.) from the left edge of the worksheet.
If ExcelDrawing.getPosition()
.getMode()
is PositioningMode.MOVE
or PositioningMode.MOVE_AND_SIZE
, then:
setter will internally use setFrom(com.gembox.spreadsheet.AnchorCell)
method.
value
- The value.unit
- The length unit of the value
parameter.public void setMode(PositioningMode value)
ExcelDrawing
(picture, chart, etc.).value
- The positioning mode of the ExcelDrawing
(picture, chart, etc.).public void setTo(AnchorCell value)
ExcelDrawing
(picture, chart, etc.) spans to.
If ExcelDrawing.getPosition()
.getMode()
is PositioningMode.FREE_FLOATING
or PositioningMode.MOVE
, then:
setter will internally use getWidth()
and getHeight()
methods, which are calculated by using width
s and height
s of columns and rows in the worksheet.
value
- The anchor cell which the ExcelDrawing
(picture, chart, etc.) spans to.public void setTop(double value)
ExcelDrawing
(picture, chart, etc.) from the top edge of the worksheet.
If ExcelDrawing.getPosition()
.getMode()
is PositioningMode.MOVE
or PositioningMode.MOVE_AND_SIZE
, then:
setter will internally use setFrom(com.gembox.spreadsheet.AnchorCell)
method.
value
- The distance (in points) of the top edge of the ExcelDrawing
(picture, chart, etc.) from the top edge of the worksheet.public void setTop(double value, LengthUnit unit)
ExcelDrawing
(picture, chart, etc.) from the top edge of the worksheet.
If ExcelDrawing.getPosition()
.getMode()
is PositioningMode.MOVE
or PositioningMode.MOVE_AND_SIZE
, then:
setter will internally use setFrom(com.gembox.spreadsheet.AnchorCell)
method.
value
- The value.unit
- The length unit of the value
parameter.public void setWidth(double value)
ExcelDrawing
(picture, chart, etc.).
If ExcelDrawing.getPosition()
.getMode()
is PositioningMode.MOVE_AND_SIZE
, then:
setter will internally use setTo(com.gembox.spreadsheet.AnchorCell)
method.
value
- The width (in points) of the ExcelDrawing
(picture, chart, etc.).public void setWidth(double value, LengthUnit unit)
ExcelDrawing
(picture, chart, etc.).
If ExcelDrawing.getPosition()
.getMode()
is PositioningMode.MOVE_AND_SIZE
, then:
setter will internally use setTo(com.gembox.spreadsheet.AnchorCell)
method.
value
- The value.unit
- The length unit of the value
parameter.public String toString()
String
that represents this ExcelDrawingPosition
instance.
This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).
toString
in class Object
String
that represents this ExcelDrawingPosition
instance.© GemBox d.o.o. — All rights reserved.