org.extex.typesetter.type.page
Interface Page

All Known Implementing Classes:

PageImpl

public interface Page

This interface describes a page for the back-end. It carries nodes and allows access to additional parameters.

Version:

$Revision: 4739 $

Author:

Gerd Neugebauer

Method Summary

Color	getColor() Getter for the background color.
Dimen	getMediaHeight() Getter for the height of the media.
Dimen	getMediaHOffset() Getter for the horizontal offset of the media.
Dimen	getMediaVOffset() Getter for the vertical offset of the media.
Dimen	getMediaWidth() Getter for the width of the media.
NodeList	getNodes() Getter for the node list.
FixedCount[]	getPageNo() Getter for the array of page numbers.
void	setColor(Color background) Setter for the background color.
void	setMediaHeight(Dimen height) Setter for the height of the media.
void	setMediaHOffset(Dimen offset) Setter for the horizontal offset of the media.
void	setMediaVOffset(Dimen offset) Setter for the vertical offset of the media.
void	setMediaWidth(Dimen width) Setter for the width of the media.

Method Detail

getColor

Color getColor()

Getter for the background color.

Returns:

the background color

getMediaHeight

Dimen getMediaHeight()

Getter for the height of the media.

Returns:

the height of the media

getMediaHOffset

Dimen getMediaHOffset()

Getter for the horizontal offset of the media.

Returns:

the horizontal offset of the media

getMediaVOffset

Dimen getMediaVOffset()

Getter for the vertical offset of the media.

Returns:

the vertical offset of the media

getMediaWidth

Dimen getMediaWidth()

Getter for the width of the media.

Returns:

the width of the media

getNodes

NodeList getNodes()

Getter for the node list. The node list describes where on the page to put characters from fonts or other graphical symbols like rules.

Returns:

the node list

getPageNo

FixedCount[] getPageNo()

Getter for the array of page numbers.

Returns:

the array of page numbers

setColor

void setColor(Color background)

Setter for the background color.

Parameters:

background - the background color

setMediaHeight

void setMediaHeight(Dimen height)

Setter for the height of the media.

Parameters:

height - the media height

setMediaHOffset

void setMediaHOffset(Dimen offset)

Setter for the horizontal offset of the media.

Parameters:

offset - the media horizontal offset

setMediaVOffset

void setMediaVOffset(Dimen offset)

Setter for the vertical offset of the media.

Parameters:

offset - the media vertical offset

setMediaWidth

void setMediaWidth(Dimen width)

Setter for the width of the media.

Parameters:

width - the media width