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
Represents a %%Page DSC comment.
-
Field Summary
Fields inherited from interface org.apache.xmlgraphics.ps.dsc.DSCParserConstants
COMMENT, DSC_COMMENT, EOF, HEADER_COMMENT, LINE
-
Constructor Summary
ConstructorsConstructorDescriptionCreates a new instance.DSCCommentPage
(int pagePosition) Creates a new instance.DSCCommentPage
(String pageName, int pagePosition) Creates a new instance. -
Method Summary
Modifier and TypeMethodDescriptionvoid
generate
(PSGenerator gen) Writes the event to the given PSGenerator.getName()
Returns the name of the DSC comment.Returns the name of the page.int
Returns the page position.boolean
Indicates whether this DSC comment has values.void
parseValue
(String value) Parses the value of the DSC comment.void
setPageName
(String name) Sets the page name.void
setPagePosition
(int position) Sets the page position.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 Details
-
DSCCommentPage
public DSCCommentPage()Creates a new instance. -
DSCCommentPage
Creates a new instance.- Parameters:
pageName
- the name of the pagepagePosition
- 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
Returns the name of the page.- Returns:
- the page name
-
setPageName
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
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
Description copied from interface:DSCComment
Parses the value of the DSC comment.- Parameters:
value
- the value- See Also:
-
generate
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:
-