Module org.apache.xmlgraphics.commons
Package org.apache.xmlgraphics.ps.dsc.events

Class DSCCommentPage

java.lang.Object
org.apache.xmlgraphics.ps.dsc.events.AbstractEvent
org.apache.xmlgraphics.ps.dsc.events.AbstractDSCComment
org.apache.xmlgraphics.ps.dsc.events.DSCCommentPage
All Implemented Interfaces:
DSCParserConstants, DSCComment, DSCEvent
public class DSCCommentPage extends AbstractDSCComment
Represents a %%Page DSC comment.

  • Constructor Details

    • DSCCommentPage

      public DSCCommentPage()
      Creates a new instance.

    • DSCCommentPage

      public DSCCommentPage(String pageName, int pagePosition)
      Creates a new instance.
      Parameters:
      pageName - the name of the page
      pagePosition - the position of the page within the file (1-based)

    • DSCCommentPage

      public DSCCommentPage(int pagePosition)
      Creates a new instance. The page name will be set to the same value as the page position.
      Parameters:
      pagePosition - the position of the page within the file (1-based)

  • Method Details

    • getPageName

      public String getPageName()
      Returns the name of the page.
      Returns:
      the page name

    • setPageName

      public void setPageName(String name)
      Sets the page name.
      Parameters:
      name - the page name

    • getPagePosition

      public int getPagePosition()
      Returns the page position.
      Returns:
      the page position (1-based)

    • setPagePosition

      public void setPagePosition(int position)
      Sets the page position.
      Parameters:
      position - the page position (1-based)

    • getName

      public String getName()
      Description copied from interface: DSCComment
      Returns the name of the DSC comment.
      Returns:
      the name of the DSC comment (without the "%%" prefix)
      See Also:

    • hasValues

      public boolean hasValues()
      Description copied from interface: DSCComment
      Indicates whether this DSC comment has values.
      Returns:
      true if the DSC comment has values
      See Also:

    • parseValue

      public void parseValue(String value)
      Description copied from interface: DSCComment
      Parses the value of the DSC comment.
      Parameters:
      value - the value
      See Also:

    • generate

      public void generate(PSGenerator gen) throws IOException
      Description copied from interface: DSCEvent
      Writes the event to the given PSGenerator.
      Parameters:
      gen - the PSGenerator to write to
      Throws:
      IOException - In case of an I/O error
      See Also: