org.odftoolkit.simple.draw

Class FrameRectangle

java.lang.Object

org.odftoolkit.simple.draw.FrameRectangle

public class FrameRectangle
extends Object

This class represents a rectangle used by a frame object.

A Rectangle specifies an area in a coordinate space that is enclosed by the Rectangle object's top-left point (x, y) in the coordinate space, its width, and its height.

Since:

0.5

Constructor Summary

Constructors

Constructor and Description
FrameRectangle(double x, double y, double width, double height, StyleTypeDefinitions.SupportedLinearMeasure linearMeasure) Create an instance of FrameRectangle with the top-left point (x, y), width, height and the measurement
FrameRectangle(String xDesc, String yDesc, String widthDesc, String heightDesc) Create an instance of FrameRectangle with the descriptions of top-left point (x, y), width and height.

Method Summary

Modifier and Type	Method and Description
double	getHeight()
String	getHeigthDesc() Return the height with measurement
StyleTypeDefinitions.SupportedLinearMeasure	getLinearMeasure()
double	getWidth()
String	getWidthDesc() Return the width with measurement
double	getX()
String	getXDesc() Return the x-axis coordinate with measurement
double	getY()
String	getYDesc() Return the y-axis coordinate with measurement
void	setHeight(double height)
void	setLinearMeasure(StyleTypeDefinitions.SupportedLinearMeasure newLinearMeasure)
void	setWidth(double width)
void	setX(double x)
void	setY(double y)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FrameRectangle

public FrameRectangle(double x,
                      double y,
                      double width,
                      double height,
                      StyleTypeDefinitions.SupportedLinearMeasure linearMeasure)

Create an instance of FrameRectangle with the top-left point (x, y), width, height and the measurement

Parameters:

x - - the x-axis coordinate

y - - the y-axis coordinate

width - - the width

height - - the height

linearMeasure - - the measurement

FrameRectangle

public FrameRectangle(String xDesc,
                      String yDesc,
                      String widthDesc,
                      String heightDesc)

Create an instance of FrameRectangle with the descriptions of top-left point (x, y), width and height.

Parameters:

xDesc - - the x-axis coordinate with measurement

yDesc - - the y-axis coordinate with measurement

widthDesc - - the width with measurement

heightDesc - - the height with measurement

Method Detail

getX

public double getX()

Returns:

the x-axis coordinate

setX

public void setX(double x)

Parameters:

x - - the x-axis coordinate to set

getY

public double getY()

Returns:

the y-axis coordinate

setY

public void setY(double y)

Parameters:

y - - the y-axis coordinate to set

getWidth

public double getWidth()

Returns:

the width

setWidth

public void setWidth(double width)

Parameters:

width - - the width to set

getHeight

public double getHeight()

Returns:

the height

setHeight

public void setHeight(double height)

Parameters:

height - - the height to set

getLinearMeasure

public StyleTypeDefinitions.SupportedLinearMeasure getLinearMeasure()

Returns:

the line measurement

setLinearMeasure

public void setLinearMeasure(StyleTypeDefinitions.SupportedLinearMeasure newLinearMeasure)

Parameters:

newLinearMeasure - the line measurement to set

getXDesc

public String getXDesc()

Return the x-axis coordinate with measurement

Returns:

the x-axis coordinate with measurement

getYDesc

public String getYDesc()

Return the y-axis coordinate with measurement

Returns:

the y-axis coordinate with measurement

getWidthDesc

public String getWidthDesc()

Return the width with measurement

Returns:

the width with measurement

getHeigthDesc

public String getHeigthDesc()

Return the height with measurement

Returns:

the height with measurement