org.pz.platypus.commands
Class BulletListPlainStartWithOptions

java.lang.Object
  org.pz.platypus.commands.BulletListPlainStartWithOptions

All Implemented Interfaces:

OutputCommandable

Direct Known Subclasses:

PdfBulletListPlainStartWithOptions

public abstract class BulletListPlainStartWithOptions
extends java.lang.Object
implements OutputCommandable

Abstract portion of command that marks the beginning of a plain bullet list (default indent and bullet char)

Field Summary

private java.lang.String

root

Constructor Summary

BulletListPlainStartWithOptions()

Method Summary

private void	errorNoParameterForStartList(GDD gdd, Token tok) Issue error if no parameter was specified
java.lang.String	getRoot() get the root of the command.
int	process(OutputContextable context, Token tok, int tokNum) method for processing this command in the output plugin.
protected abstract int	startNewList(OutputContextable context, Token tok, int tokNum)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

root

private final java.lang.String root

See Also:

Constant Field Values

Constructor Detail

BulletListPlainStartWithOptions

public BulletListPlainStartWithOptions()

Method Detail

startNewList

protected abstract int startNewList(OutputContextable context,
                                    Token tok,
                                    int tokNum)

process

public int process(OutputContextable context,
                   Token tok,
                   int tokNum)

Description copied from interface: OutputCommandable

method for processing this command in the output plugin.

Specified by:

process in interface OutputCommandable

Parameters:

context - the context/state of the output document

tok - the command token as found in the token stream

tokNum - the number of the token in the token list

errorNoParameterForStartList

private void errorNoParameterForStartList(GDD gdd,
                                          Token tok)

Issue error if no parameter was specified

Parameters:

gdd - container of literals and logger

tok - token with missing parameter

getRoot

public java.lang.String getRoot()

Description copied from interface: OutputCommandable

get the root of the command. For example, fsize: in [fsize:12pt]

Specified by:

getRoot in interface OutputCommandable

Returns:

the root as a string