org.apache.xmlgraphics.ps.dsc.events
Class DSCCommentTitle

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

All Implemented Interfaces:

DSCParserConstants, DSCComment, DSCEvent

public class DSCCommentTitle
extends AbstractDSCComment

Represents a %%Title DSC comment.

Field Summary

Fields inherited from interface org.apache.xmlgraphics.ps.dsc.DSCParserConstants

COMMENT, DSC_COMMENT, EOF, HEADER_COMMENT, LINE

Constructor Summary

DSCCommentTitle()
Creates a new instance.

DSCCommentTitle(String title)
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.
String	getTitle() Returns the title.
boolean	hasValues() Indicates whether this DSC comment has values.
void	parseValue(String value) Parses the value of the DSC comment.

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

DSCCommentTitle

public DSCCommentTitle()

Creates a new instance.

DSCCommentTitle

public DSCCommentTitle(String title)

Creates a new instance.

Parameters:

title - the title text

Method Detail

getTitle

public String getTitle()

Returns the title.

Returns:

the title

getName

public String getName()

Returns the name of the DSC comment.

Returns:

the name of the DSC comment (without the "%%" prefix)

hasValues

public boolean hasValues()

Indicates whether this DSC comment has values.

Returns:

true if the DSC comment has values

parseValue

public void parseValue(String value)

Parses the value of the DSC comment.

Parameters:

value - the value

generate

public void generate(PSGenerator gen)
              throws IOException

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)