Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| xmlgraphics-commons 1.5
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.xmlgraphics.ps.dsc.events
Class DSCCommentPages

    java.lang.Object
      org.apache.xmlgraphics.ps.dsc.events.AbstractEvent
          org.apache.xmlgraphics.ps.dsc.events.AbstractDSCComment
              org.apache.xmlgraphics.ps.dsc.events.DSCCommentPages

All Implemented Interfaces:
  DSCParserConstants, DSCComment, DSCEvent

    public class DSCCommentPages

extends AbstractDSCComment

Represents the %%Pages DSC comment.

Field Summary

Fields inherited from interface org.apache.xmlgraphics.ps.dsc.DSCParserConstants
`COMMENT, DSC_COMMENT, EOF, HEADER_COMMENT, LINE`

Constructor Summary
`DSCCommentPages()` Creates a new instance.
`DSCCommentPages(int pageCount)` Creates a new instance.

Method Summary
`void` | `generate(PSGenerator gen)` Writes the event to the given PSGenerator.
`String` | `getName()` Returns the name of the DSC comment.
`int` | `getPageCount()` Returns the page count.
`boolean` | `hasValues()` Indicates whether this DSC comment has values.
`void` | `parseValue(String value)` Parses the value of the DSC comment.
`void` | `setPageCount(int count)` Sets the page count.

Methods inherited from class org.apache.xmlgraphics.ps.dsc.events.AbstractDSCComment
`asDSCComment, getEventType, isAtend, isDSCComment, splitParams`

Methods inherited from class org.apache.xmlgraphics.ps.dsc.events.AbstractEvent
`asLine, isComment, isHeaderComment, isLine`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface org.apache.xmlgraphics.ps.dsc.events.DSCEvent
`asLine, isComment, isHeaderComment, isLine`

Constructor Detail

### DSCCommentPages

    public DSCCommentPages()

  Creates a new instance.

### DSCCommentPages

    public DSCCommentPages(int pageCount)

  Creates a new instance.

  Parameters:
    `pageCount` - the number of pages

Method Detail

### getPageCount

    public int getPageCount()

  Returns the page count.

  Returns:
    the page count

### setPageCount

    public void setPageCount(int count)

  Sets the page count.

  Parameters:
    `count` - the new page count

### 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:
    `DSCComment.getName()`

### 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:
    `DSCComment.hasValues()`

### parseValue

    public void parseValue(String value)

  Description copied from interface: `DSCComment`
  Parses the value of the DSC comment.

  Parameters:
    `value` - the value
  See Also:
    `DSCComment.parseValue(java.lang.String)`

### 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:
    `DSCEvent.generate(org.apache.xmlgraphics.ps.PSGenerator)`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| xmlgraphics-commons 1.5
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright 1999-2012 The Apache Software Foundation. All Rights Reserved.