|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.pz.platypus.plugin.pdf.commands.DefUserString
public class DefUserString
handles processing of the definition of a user string (macro). Handled by the plug-in because the same value can be redefined numerous times by the Platypus file in context-dependent ways.
Field Summary | |
---|---|
private ParamType |
parameterType
|
private java.lang.String |
root
|
private boolean |
validInCode
|
Constructor Summary | |
---|---|
DefUserString()
|
Method Summary | |
---|---|
void |
convertToTextToken(Source source,
TokenList tl)
In the event of an error, the command is converted into a series of text tokens (after the error message is shown). |
(package private) java.lang.String |
extractMacroName(java.lang.String text)
Extracts the macro name from the beginning of a string |
(package private) java.lang.String |
extractMacroValue(java.lang.String text,
java.lang.String macroName)
Extracts the substitute value from the macro definition |
ParamType |
getParamType()
|
java.lang.String |
getRoot()
get the root of the command. |
java.lang.String |
getRootSubstitute()
|
TokenType |
getTokenType()
|
boolean |
isAllowedInCode()
|
void |
issueErrorMessage(GDD gdd,
Source source,
java.lang.String macro)
|
int |
process(IOutputContext context,
Token tok,
int tokNum)
method for processing this command in the output plugin. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private java.lang.String root
private ParamType parameterType
private boolean validInCode
Constructor Detail |
---|
public DefUserString()
Method Detail |
---|
public int process(IOutputContext context, Token tok, int tokNum)
IOutputCommand
process
in interface IOutputCommand
context
- the context/state of the output documenttok
- the command token as found in the token streamtokNum
- the number of the token in the token listjava.lang.String extractMacroName(java.lang.String text)
text
- the string to extract the macro name from
java.lang.String extractMacroValue(java.lang.String text, java.lang.String macroName)
text
- the macro definitionmacroName
- the macro name
public void issueErrorMessage(GDD gdd, Source source, java.lang.String macro)
public void convertToTextToken(Source source, TokenList tl)
source
- the current file # and line #tl
- the token list to add the text token topublic boolean isAllowedInCode()
public ParamType getParamType()
public java.lang.String getRoot()
IOutputCommand
getRoot
in interface IOutputCommand
public java.lang.String getRootSubstitute()
public TokenType getTokenType()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |