PageLegend

Inheritance: java.lang.Object

public class PageLegend

Represents a page legend which is used for project printing.

Constructors

Constructor	Description
PageLegend()

Methods

Method	Description
getCenteredImage()	Gets the centered image to be displayed in the page legend.
getCenteredText()	Gets the centered text to display in the page legend.
getLeftImage()	Gets the left aligned image to be displayed in the page legend.
getLeftText()	Gets the left aligned text to display in the page legend.
getLegendOn()	Gets the pages on which the legend appears.
getRightImage()	Gets the right aligned image to be displayed in the page legend.
getRightText()	Gets the right aligned text to display in the page legend.
getWidth()	Gets the width of the legend.
setCenteredImage(Image value)	Sets the centered image to be displayed in the page legend.
setCenteredText(String value)	Sets the centered text to display in the page legend.
setLeftImage(Image value)	Sets the left aligned image to be displayed in the page legend.
setLeftText(String value)	Sets the left aligned text to display in the page legend.
setLegendOn(int value)	Sets the pages on which the legend appears.
setRightImage(Image value)	Sets the right aligned image to be displayed in the page legend.
setRightText(String value)	Sets the right aligned text to display in the page legend.
setWidth(double value)	Sets the width of the legend.

PageLegend()

public PageLegend()

getCenteredImage()

public final Image getCenteredImage()

Gets the centered image to be displayed in the page legend.

Returns: java.awt.Image - the centered image to be displayed in the page legend.

getCenteredText()

public final String getCenteredText()

Gets the centered text to display in the page legend.

Returns: java.lang.String - the centered text to display in the page legend.

getLeftImage()

public final Image getLeftImage()

Gets the left aligned image to be displayed in the page legend.

Returns: java.awt.Image - the left aligned image to be displayed in the page legend.

getLeftText()

public final String getLeftText()

Gets the left aligned text to display in the page legend.

Returns: java.lang.String - the left aligned text to display in the page legend.

getLegendOn()

public final int getLegendOn()

Gets the pages on which the legend appears. Can be one of the values of the Legend enumeration.

Returns: int - the pages on which the legend appears.

getRightImage()

public final Image getRightImage()

Gets the right aligned image to be displayed in the page legend.

Returns: java.awt.Image - the right aligned image to be displayed in the page legend.

getRightText()

public final String getRightText()

Gets the right aligned text to display in the page legend.

Returns: java.lang.String - the right aligned text to display in the page legend.

getWidth()

public final double getWidth()

Gets the width of the legend.

Returns: double - the width of the legend.

setCenteredImage(Image value)

public final void setCenteredImage(Image value)

Sets the centered image to be displayed in the page legend.

Parameters:

Parameter	Type	Description
value	java.awt.Image	the centered image to be displayed in the page legend.

setCenteredText(String value)

public final void setCenteredText(String value)

Sets the centered text to display in the page legend.

Parameters:

Parameter	Type	Description
value	java.lang.String	the centered text to display in the page legend.

setLeftImage(Image value)

public final void setLeftImage(Image value)

Sets the left aligned image to be displayed in the page legend.

Parameters:

Parameter	Type	Description
value	java.awt.Image	the left aligned image to be displayed in the page legend.

setLeftText(String value)

public final void setLeftText(String value)

Sets the left aligned text to display in the page legend.

Parameters:

Parameter	Type	Description
value	java.lang.String	the left aligned text to display in the page legend.

setLegendOn(int value)

public final void setLegendOn(int value)

Sets the pages on which the legend appears. Can be one of the values of the Legend enumeration.

Parameters:

Parameter	Type	Description
value	int	the pages on which the legend appears.

setRightImage(Image value)

public final void setRightImage(Image value)

Sets the right aligned image to be displayed in the page legend.

Parameters:

Parameter	Type	Description
value	java.awt.Image	the right aligned image to be displayed in the page legend.

setRightText(String value)

public final void setRightText(String value)

Sets the right aligned text to display in the page legend.

Parameters:

Parameter	Type	Description
value	java.lang.String	the right aligned text to display in the page legend.

setWidth(double value)

public final void setWidth(double value)

Sets the width of the legend.

Parameters:

Parameter	Type	Description
value	double	the width of the legend.