com.f1j.drawing
Interface PlacementFormat

public interface PlacementFormat

extends FormatBase

The Position Format interface.

Inner Class Summary

static class

PlacementFormat.EProperty Placement format property enumeration

Field Summary

static PlacementFormat.EProperty	eHeight Height property
static PlacementFormat.EProperty	eLockAspectRatio Lock Aspect Ratio property
static PlacementFormat.EProperty	eOriginalHeight Original height property
static PlacementFormat.EProperty	eOriginalWidth Original width property
static PlacementFormat.EProperty	eScaleHeight Scale height property
static PlacementFormat.EProperty	eScaleRelativeToOriginalSize Scale Relative To Original Size property
static PlacementFormat.EProperty	eScaleWidth Scale width property
static PlacementFormat.EProperty	eWidth Width property

Method Summary

double	getHeight() Returns the height.
double	getOriginalHeight() Returns the original height.
double	getOriginalWidth() Returns the original width.
int	getScaleHeight() Returns the scale height.
int	getScaleWidth() Returns the scale width.
double	getWidth() Returns the width.
boolean	isLockAspectRatio() Returns whether or not the aspect ratio is locked.
boolean	isScaleRelativeToOriginalSize() Returns whether or not this is scaled relative to the original size.
void	setHeight(double height) Sets the height.
void	setLockAspectRatio(boolean lock) Sets whether or not the aspect ratio is locked.
void	setScaleHeight(int factor) Sets the scale height.
void	setScaleRelativeToOriginalSize(boolean relative) Sets whether or not this is scaled relative to the original size.
void	setScaleWidth(int factor) Sets the scale width.
void	setWidth(double width) Sets the width.

Methods inherited from interface com.f1j.util.FormatBase

isUndefined, isUndefined, isUsed, setUndefined, undefineAll, useAll

Field Detail

eHeight

public static final PlacementFormat.EProperty eHeight

Height property

eWidth

public static final PlacementFormat.EProperty eWidth

Width property

eScaleHeight

public static final PlacementFormat.EProperty eScaleHeight

Scale height property

eScaleWidth

public static final PlacementFormat.EProperty eScaleWidth

Scale width property

eOriginalHeight

public static final PlacementFormat.EProperty eOriginalHeight

Original height property

eOriginalWidth

public static final PlacementFormat.EProperty eOriginalWidth

Original width property

eLockAspectRatio

public static final PlacementFormat.EProperty eLockAspectRatio

Lock Aspect Ratio property

eScaleRelativeToOriginalSize

public static final PlacementFormat.EProperty eScaleRelativeToOriginalSize

Scale Relative To Original Size property

Method Detail

getHeight

public double getHeight()

Returns the height.

Returns:

the height.

getOriginalHeight

public double getOriginalHeight()

Returns the original height.

Returns:

the original height.

getOriginalWidth

public double getOriginalWidth()

Returns the original width.

Returns:

the original width.

getScaleHeight

public int getScaleHeight()

Returns the scale height.

Returns:

the scale height.

getScaleWidth

public int getScaleWidth()

Returns the scale width.

Returns:

the scale width.

getWidth

public double getWidth()

Returns the width.

Returns:

the width.

isLockAspectRatio

public boolean isLockAspectRatio()

Returns whether or not the aspect ratio is locked.

Returns:

whether or not the aspect ratio is locked.

isScaleRelativeToOriginalSize

public boolean isScaleRelativeToOriginalSize()

Returns whether or not this is scaled relative to the original size.

Returns:

whether or not this is scaled relative to the original size.

setHeight

public void setHeight(double height)
               throws InvalidArgumentException,
                      F1Exception

Sets the height.

Parameters:

height - The height.

setLockAspectRatio

public void setLockAspectRatio(boolean lock)

Sets whether or not the aspect ratio is locked.

Parameters:

lock - whether or not the aspect ratio is locked.

setScaleRelativeToOriginalSize

public void setScaleRelativeToOriginalSize(boolean relative)

Sets whether or not this is scaled relative to the original size.

Parameters:

relative - whether or not this is scaled relative to the original size.

setScaleHeight

public void setScaleHeight(int factor)
                    throws InvalidArgumentException,
                           F1Exception

Sets the scale height.

Parameters:

factor - the scale height.

setScaleWidth

public void setScaleWidth(int factor)
                   throws InvalidArgumentException,
                          F1Exception

Sets the scale width.

Parameters:

factor - the scale width.

setWidth

public void setWidth(double width)
              throws InvalidArgumentException,
                     F1Exception

Sets the width.

Parameters:

width - the width.