com.jfimagine.jfgraph.shape.decorate
Class JFPageFormat

java.lang.Object
  |
  +--com.jfimagine.jfgraph.shape.base.AbstractObject
        |
        +--com.jfimagine.jfgraph.shape.decorate.JFPageFormat

All Implemented Interfaces:

java.lang.Cloneable

public class JFPageFormat

extends AbstractObject

Page format class encapsulates java.awt.print.PageFormat and some storage methods from abstractObject.

Version:

$Revision: 1.1 $

Author:

CookieMaker

Field Summary

static int	INCH
static int	INCH_SCREEN screen resolution, pixel per inch
static java.awt.Dimension	PAGESIZE_A0 page size for each page type, unit in pixels
static java.awt.Dimension	PAGESIZE_A1
static java.awt.Dimension	PAGESIZE_A2
static java.awt.Dimension	PAGESIZE_A3
static java.awt.Dimension	PAGESIZE_A4
static java.awt.Dimension	PAGESIZE_A4SMALL
static java.awt.Dimension	PAGESIZE_A5
static java.awt.Dimension	PAGESIZE_B0
static java.awt.Dimension	PAGESIZE_B1
static java.awt.Dimension	PAGESIZE_B2
static java.awt.Dimension	PAGESIZE_B3
static java.awt.Dimension	PAGESIZE_B4
static java.awt.Dimension	PAGESIZE_B5
static java.awt.Dimension	PAGESIZE_DEFAULT
static int	PAGETYPE_A0 Page types
static int	PAGETYPE_A1
static int	PAGETYPE_A2
static int	PAGETYPE_A3
static int	PAGETYPE_A4
static int	PAGETYPE_A4SMALL
static int	PAGETYPE_A5
static int	PAGETYPE_B0
static int	PAGETYPE_B1
static int	PAGETYPE_B2
static int	PAGETYPE_B3
static int	PAGETYPE_B4
static int	PAGETYPE_B5
static int	PAGETYPE_CUSTOM
static java.lang.String	XML_BOTTOMMARGIN A XML string tag represents the bottom margin of a page.
static java.lang.String	XML_HEIGHT A XML string tag represents the page height
static java.lang.String	XML_LEFTMARGIN A XML string tag represents the left margin of a page.
static java.lang.String	XML_ORIENTATION A XML string tag represents the orientation of a page.
static java.lang.String	XML_PAGEFORMAT A XML string tag represents a page format.
static java.lang.String	XML_RIGHTMARGIN A XML string tag represents the right margin of a page.
static java.lang.String	XML_TOPMARGIN A XML string tag represents the top margin of a page.
static java.lang.String	XML_WIDTH A XML string tag represents the page width.

Fields inherited from class com.jfimagine.jfgraph.shape.base.AbstractObject

m_lastError, XML_OBJECTID, XML_OBJECTTYPE

Constructor Summary

JFPageFormat()
Constructor for JFPageFormat

Method Summary

protected void	appendChildToDOM(Element element, JFVersion version) Append necessary xml child for current element, this method will be called internally by toDOM.
java.lang.Object	clone() Creates a new object of the same class and with the same contents as this object.
protected AbstractObject	cloneMe() Creates a new AbstractObject of the same class and with the same contents as this object.
boolean	equals(java.lang.Object obj) Determines whether or not two objects are equal.
protected void	extractChildFromDOM(Element element, JFVersion version) Extract needed xml child from current element, this method will be called internally by fromDOM.
double	getBottomMargin()
double	getHeight()
double	getLeftMargin()
int	getOrientation()
java.awt.print.PageFormat	getPageFormat()
double	getRightMargin()
static java.awt.Dimension	getScreenDimension(java.awt.Dimension d) A page dimension is a 72 times value of an inch, but on screen that would be another times, e.g. 96
static int	getScreenSize(int size) A page size is a 72 times value of an inch, but on screen that would be another times, e.g. 96
double	getTopMargin()
double	getWidth()
int	hashCode() Returns the hashcode for this Object.
void	loadFromStream(JFReader stream, boolean skipHead, JFVersion version) Load object data from a binary stream
void	saveToStream(JFWriter stream, JFVersion version) Save this object to a binary stream
void	setBottomMargin(double bottomMargin)
void	setHeight(double height)
void	setLeftMargin(double leftMargin)
void	setOrientation(int orientation)
void	setPageFormat(java.awt.print.PageFormat pageFormat)
void	setRightMargin(double rightMargin)
void	setTopMargin(double topMargin)
void	setWidth(double width)
java.lang.String	toString() Convert this object to String

Methods inherited from class com.jfimagine.jfgraph.shape.base.AbstractObject

fromDOM, getLastError, getMaxObjectId, getObjectId, getObjectType, getXMLTag, getZoomScale, isShowDesign, setLastError, setObjectId, setObjectType, setShowDesign, setValue, setXMLTag, setZoomScale, toDOM

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

XML_PAGEFORMAT

public static final java.lang.String XML_PAGEFORMAT

A XML string tag represents a page format.

See Also:

Constant Field Values

XML_WIDTH

public static final java.lang.String XML_WIDTH

A XML string tag represents the page width.

See Also:

Constant Field Values

XML_HEIGHT

public static final java.lang.String XML_HEIGHT

A XML string tag represents the page height

See Also:

Constant Field Values

XML_LEFTMARGIN

public static final java.lang.String XML_LEFTMARGIN

A XML string tag represents the left margin of a page.

See Also:

Constant Field Values

XML_RIGHTMARGIN

public static final java.lang.String XML_RIGHTMARGIN

A XML string tag represents the right margin of a page.

See Also:

Constant Field Values

XML_TOPMARGIN

public static final java.lang.String XML_TOPMARGIN

A XML string tag represents the top margin of a page.

See Also:

Constant Field Values

XML_BOTTOMMARGIN

public static final java.lang.String XML_BOTTOMMARGIN

A XML string tag represents the bottom margin of a page.

See Also:

Constant Field Values

XML_ORIENTATION

public static final java.lang.String XML_ORIENTATION

A XML string tag represents the orientation of a page.

See Also:

Constant Field Values

PAGETYPE_A0

public static final int PAGETYPE_A0

Page types

See Also:

Constant Field Values

PAGETYPE_A1

public static final int PAGETYPE_A1

See Also:

Constant Field Values

PAGETYPE_A2

public static final int PAGETYPE_A2

See Also:

Constant Field Values

PAGETYPE_A3

public static final int PAGETYPE_A3

See Also:

Constant Field Values

PAGETYPE_A4

public static final int PAGETYPE_A4

See Also:

Constant Field Values

PAGETYPE_A4SMALL

public static final int PAGETYPE_A4SMALL

See Also:

Constant Field Values

PAGETYPE_A5

public static final int PAGETYPE_A5

See Also:

Constant Field Values

PAGETYPE_B0

public static final int PAGETYPE_B0

See Also:

Constant Field Values

PAGETYPE_B1

public static final int PAGETYPE_B1

See Also:

Constant Field Values

PAGETYPE_B2

public static final int PAGETYPE_B2

See Also:

Constant Field Values

PAGETYPE_B3

public static final int PAGETYPE_B3

See Also:

Constant Field Values

PAGETYPE_B4

public static final int PAGETYPE_B4

See Also:

Constant Field Values

PAGETYPE_B5

public static final int PAGETYPE_B5

See Also:

Constant Field Values

PAGETYPE_CUSTOM

public static final int PAGETYPE_CUSTOM

See Also:

Constant Field Values

INCH_SCREEN

public static final int INCH_SCREEN

screen resolution, pixel per inch

INCH

public static final int INCH

See Also:

Constant Field Values

PAGESIZE_A0

public static final java.awt.Dimension PAGESIZE_A0

page size for each page type, unit in pixels

PAGESIZE_A1

public static final java.awt.Dimension PAGESIZE_A1

PAGESIZE_A2

public static final java.awt.Dimension PAGESIZE_A2

PAGESIZE_A3

public static final java.awt.Dimension PAGESIZE_A3

PAGESIZE_A4

public static final java.awt.Dimension PAGESIZE_A4

PAGESIZE_A4SMALL

public static final java.awt.Dimension PAGESIZE_A4SMALL

PAGESIZE_A5

public static final java.awt.Dimension PAGESIZE_A5

PAGESIZE_B0

public static final java.awt.Dimension PAGESIZE_B0

PAGESIZE_B1

public static final java.awt.Dimension PAGESIZE_B1

PAGESIZE_B2

public static final java.awt.Dimension PAGESIZE_B2

PAGESIZE_B3

public static final java.awt.Dimension PAGESIZE_B3

PAGESIZE_B4

public static final java.awt.Dimension PAGESIZE_B4

PAGESIZE_B5

public static final java.awt.Dimension PAGESIZE_B5

PAGESIZE_DEFAULT

public static final java.awt.Dimension PAGESIZE_DEFAULT

Constructor Detail

JFPageFormat

public JFPageFormat()

Constructor for JFPageFormat

Method Detail

getScreenDimension

public static java.awt.Dimension getScreenDimension(java.awt.Dimension d)

A page dimension is a 72 times value of an inch, but on screen that would be another times, e.g. 96

getScreenSize

public static int getScreenSize(int size)

A page size is a 72 times value of an inch, but on screen that would be another times, e.g. 96

getWidth

public double getWidth()

setWidth

public void setWidth(double width)

getHeight

public double getHeight()

setHeight

public void setHeight(double height)

getLeftMargin

public double getLeftMargin()

setLeftMargin

public void setLeftMargin(double leftMargin)

getRightMargin

public double getRightMargin()

setRightMargin

public void setRightMargin(double rightMargin)

getTopMargin

public double getTopMargin()

setTopMargin

public void setTopMargin(double topMargin)

getBottomMargin

public double getBottomMargin()

setBottomMargin

public void setBottomMargin(double bottomMargin)

getOrientation

public int getOrientation()

setOrientation

public void setOrientation(int orientation)

getPageFormat

public java.awt.print.PageFormat getPageFormat()

setPageFormat

public void setPageFormat(java.awt.print.PageFormat pageFormat)

toString

public java.lang.String toString()

Convert this object to String

Overrides:

toString in class AbstractObject

Returns:

An string represents the content of the object

cloneMe

protected AbstractObject cloneMe()
                          throws java.lang.CloneNotSupportedException

Creates a new AbstractObject of the same class and with the same contents as this object. This method implements the method defined in AbstractObject.

Specified by:

cloneMe in class AbstractObject

Returns:

A clone of this class.

java.lang.CloneNotSupportedException

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Creates a new object of the same class and with the same contents as this object.

Overrides:

clone in class AbstractObject

Returns:

A clone of this instance.

java.lang.CloneNotSupportedException

hashCode

public int hashCode()

Returns the hashcode for this Object.

Overrides:

hashCode in class AbstractObject

Returns:

hash code for this Point2D.

equals

public boolean equals(java.lang.Object obj)

Determines whether or not two objects are equal.

Overrides:

equals in class AbstractObject

Parameters:

obj - an object to be compared with this object

Returns:

true if the object to be compared is an instance of Port and has the same values; false otherwise.

appendChildToDOM

protected void appendChildToDOM(Element element,
                                JFVersion version)

Append necessary xml child for current element, this method will be called internally by toDOM.

Overrides:

appendChildToDOM in class AbstractObject

Parameters:

element - A XML element to append child xml nodes

version - A file version notification so this object can obey the rules to save data.

extractChildFromDOM

protected void extractChildFromDOM(Element element,
                                   JFVersion version)

Extract needed xml child from current element, this method will be called internally by fromDOM.

Overrides:

extractChildFromDOM in class AbstractObject

Parameters:

element - An element used to extract needed xml child

version - A file version notification so this object can obey the rules to fetch data.

saveToStream

public void saveToStream(JFWriter stream,
                         JFVersion version)
                  throws java.io.IOException

Save this object to a binary stream

Overrides:

saveToStream in class AbstractObject

Parameters:

stream - An binary output stream

version - A file version notification so this object can obey the rules to save data.

Throws:

java.io.IOException

loadFromStream

public void loadFromStream(JFReader stream,
                           boolean skipHead,
                           JFVersion version)
                    throws java.io.IOException

Load object data from a binary stream

Overrides:

loadFromStream in class AbstractObject

Parameters:

stream - An binary input stream

skipHead - Skip head 'TYPE' check, an shape object should always has its own shape-type stored, if this shape-type has already been readed, this loadFromStream should/could not read the type anymore.

version - A file version notification so this object can obey the rules to fetch data.

Throws:

java.io.IOException