public class PageLegend extends Object
Represents a page legend which is used for project printing.
Constructor and Description |
---|
PageLegend() |
Modifier and Type | Method and Description |
---|---|
String |
getCenteredText()
The centered text to display in the page legend.
|
String |
getLeftText()
The left aligned text to display in the page legend.
|
int |
getLegendOn()
Specifies the pages on which the legend appears.
|
String |
getRightText()
The right aligned text to display in the page legend.
|
double |
getWidth()
Specifies a width of the legend.
|
void |
setCenteredText(String value)
Sets the centered text to display in the page legend.
|
void |
setLeftText(String value)
Sets the left aligned text to display in the page legend.
|
void |
setLegendOn(int value)
Specifies the pages on which the legend appears.
|
void |
setRightText(String value)
Sets the right aligned text to display in the page legend.
|
void |
setWidth(double value)
Specifies a width of the legend.
|
public String getCenteredText()
The centered text to display in the page legend.
public void setCenteredText(String value)
Sets the centered text to display in the page legend.
value
- the centered text to display in the page legend.public String getLeftText()
The left aligned text to display in the page legend.
public void setLeftText(String value)
Sets the left aligned text to display in the page legend.
value
- the left aligned text to display in the page legend.public int getLegendOn()
Specifies the pages on which the legend appears. Can be one of the values of the Legend
enum.
public void setLegendOn(int value)
Specifies the pages on which the legend appears. Can be one of the values of the Legend
enum.
value
- the specified page number on which the legend appears.public String getRightText()
The right aligned text to display in the page legend.
public void setRightText(String value)
Sets the right aligned text to display in the page legend.
value
- the specified right aligned text to display in the page legend.public double getWidth()
Specifies a width of the legend.
public void setWidth(double value)
Specifies a width of the legend.
value
- the specified width of the legend.