DynamicPDF by ceTe Software

com.cete.dynamicpdf
Class AreaDimensions

java.lang.Object
  |
  +--com.cete.dynamicpdf.AreaDimensions
Direct Known Subclasses:
PageDimensions

public class AreaDimensions
extends java.lang.Object

Represents the dimensions of an area.


Field Summary
 Dimensions body
          Represents the dimensions of the areas body.
 Dimensions edge
          Represents the dimensions of the areas edge.
 
Constructor Summary
  AreaDimensions(AreaDimensions areaDimensions, float x, float y, float width, float height)
          Creates a new instance of AreaDimensions.
  AreaDimensions(Dimensions edge)
          Creates a new instance of AreaDimensions.
protected AreaDimensions(Dimensions edge, Dimensions body)
          Creates a new instance of AreaDimensions.
  AreaDimensions(float left, float top, float right, float bottom)
          Creates a new instance of AreaDimensions.
 
Method Summary
 float getBottomMargin()
          Gets the bottom margin of the page dimensions.
 float getHeight()
          Gets the height of the page dimensions.
 float getLeftMargin()
          Gets the left margin of the page dimensions.
 float getPdfX(float x)
          Returns the translated X coordinate.
 float getPdfY(float y)
          Gets the translated Y coordinate.
 float getRightMargin()
          Gets the right margin of the page dimensions.
 float getTopMargin()
          Gets the top margin of the page dimensions.
 float getWidth()
          Gets the width of the page dimensions.
 void setBottomMargin(float value)
          Sets the bottom margin of the page dimensions.
 void setHeight(float value)
          Sets the height of the page dimensions.
 void setLeftMargin(float value)
          Sets the left margin of the page dimensions.
 void setRightMargin(float value)
          Sets the right margin of the page dimensions.
 void setTopMargin(float value)
          Sets the top margin of the page dimensions.
 void setWidth(float value)
          Sets the width of the page dimensions.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

edge

public Dimensions edge
Represents the dimensions of the areas edge.


body

public Dimensions body
Represents the dimensions of the areas body.

Constructor Detail

AreaDimensions

public AreaDimensions(float left,
                      float top,
                      float right,
                      float bottom)
Creates a new instance of AreaDimensions.

Parameters:
left - Left edge of the area.
top - Top edge of the area.
right - Right edge of the area.
bottom - Bottom edge of the area.

AreaDimensions

public AreaDimensions(Dimensions edge)
Creates a new instance of AreaDimensions.

Parameters:
edge - Edge dimensions of the area.

AreaDimensions

protected AreaDimensions(Dimensions edge,
                         Dimensions body)
Creates a new instance of AreaDimensions.

Parameters:
edge - Edge dimensions of the area.
body - Body dimensions of the area.

AreaDimensions

public AreaDimensions(AreaDimensions areaDimensions,
                      float x,
                      float y,
                      float width,
                      float height)
Creates a new instance of AreaDimensions.

Parameters:
areaDimensions - Parent area dimentions.
x - X coordinate for area.
y - Y coordinate for area.
width - Width of area.
height - Height of area.
Method Detail

getWidth

public float getWidth()
Gets the width of the page dimensions.


setWidth

public void setWidth(float value)
Sets the width of the page dimensions.


getHeight

public float getHeight()
Gets the height of the page dimensions.


setHeight

public void setHeight(float value)
Sets the height of the page dimensions.


getLeftMargin

public float getLeftMargin()
Gets the left margin of the page dimensions.


setLeftMargin

public void setLeftMargin(float value)
Sets the left margin of the page dimensions.


getTopMargin

public float getTopMargin()
Gets the top margin of the page dimensions.


setTopMargin

public void setTopMargin(float value)
Sets the top margin of the page dimensions.


getRightMargin

public float getRightMargin()
Gets the right margin of the page dimensions.


setRightMargin

public void setRightMargin(float value)
Sets the right margin of the page dimensions.


getBottomMargin

public float getBottomMargin()
Gets the bottom margin of the page dimensions.


setBottomMargin

public void setBottomMargin(float value)
Sets the bottom margin of the page dimensions.


getPdfY

public float getPdfY(float y)
Gets the translated Y coordinate.

Parameters:
y - Y coordinate to translate.
Returns:
A translated Y coordinate.

getPdfX

public float getPdfX(float x)
Returns the translated X coordinate.

Parameters:
x - X coordinate to translate.
Returns:
A translated X coordinate.

DynamicPDF by ceTe Software

API Reference for DynamicPDF™ for Java generated on December 20, 2005
© Copyright 2005, ceTe Software