com.aspose.tasks

Interfaces

Classes

Exceptions

Skip navigation links
com.aspose.tasks

Class PageLegend


  • public class PageLegend
extends Object

    Represents a page legend which is used for project printing.

    • Constructor Detail

      • PageLegend

        public PageLegend()

    • Method Detail

      • getCenteredImage

        public final Image getCenteredImage()

        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)

        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()

        The centered text to display in the page legend.

        Returns:
        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()

        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)

        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()

        The left aligned text to display in the page legend.

        Returns:
        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()

        Specifies the pages on which the legend appears. Can be one of the values of the Legend enum.

        Returns:
        returns the pages on which the legend appears.

      • setLegendOn

        public final void setLegendOn(int value)

        Specifies the pages on which the legend appears. Can be one of the values of the Legend enum.

        Parameters:
        value - the specified page number on which the legend appears.

      • getRightImage

        public final Image getRightImage()

        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)

        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()

        The right aligned text to display in the page legend.

        Returns:
        returns the right aligned text to be displayed 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 specified right aligned text to display in the page legend.

      • getWidth

        public final double getWidth()

        Specifies a width of the legend.

        Returns:
        returns a width of the legend.

      • setWidth

        public final void setWidth(double value)

        Specifies a width of the legend.

        Parameters:
        value - the specified width of the legend.