Package com.aspose.tasks

Class PageLegend

java.lang.Object

com.aspose.tasks.PageLegend

public class PageLegend
extends Object

Represents a page legend which is used for project printing.

Constructor Summary

Constructors

Constructor	Description
PageLegend()

Method Summary

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PageLegend

public PageLegend()

Method Detail

getCenteredImage

public final Image getCenteredImage()

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

Returns:

the centered image to be displayed in the page legend.

setCenteredImage

public final void setCenteredImage(Image value)

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

Parameters:

value - 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:

the centered text to display in the page legend.

setCenteredText

public final void setCenteredText(String value)

Sets the centered text to display in the page legend.

Parameters:

value - 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:

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

setLeftImage

public final void setLeftImage(Image value)

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

Parameters:

value - 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:

the left aligned text to display in the page legend.

setLeftText

public final void setLeftText(String value)

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

Parameters:

value - 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:

the pages on which the legend appears.

setLegendOn

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:

value - 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:

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

setRightImage

public final void setRightImage(Image value)

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

Parameters:

value - 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:

the right aligned text to display in the page legend.

setRightText

public final void setRightText(String value)

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

Parameters:

value - the right aligned text to display in the page legend.

getWidth

public final double getWidth()

Gets the width of the legend.

Returns:

the width of the legend.

setWidth

public final void setWidth(double value)

Sets the width of the legend.

Parameters:

value - the width of the legend.