Skip navigation links
BioPCD canvas v1.1.0 API
A B C D E F G I J K L M N O P R S T U V W 

A

addEscapes(String) - Static method in error org.biopcd.canvas.TokenMgrError
Replaces unprintable characters by their escaped (or unicode escaped) equivalents in the given string
adjustBeginLineColumn(int, int) - Method in class org.biopcd.canvas.SimpleCharStream
Method to adjust line and column numbers for the start of a token.

B

backup(int) - Method in class org.biopcd.canvas.SimpleCharStream
Backup a number of characters.
beginColumn - Variable in class org.biopcd.canvas.Token
The column number of the first character of this Token.
beginLine - Variable in class org.biopcd.canvas.Token
The line number of the first character of this Token.
BeginToken() - Method in class org.biopcd.canvas.SimpleCharStream
Start.
bufcolumn - Variable in class org.biopcd.canvas.SimpleCharStream
 
buffer - Variable in class org.biopcd.canvas.SimpleCharStream
 
bufline - Variable in class org.biopcd.canvas.SimpleCharStream
 
bufpos - Variable in class org.biopcd.canvas.SimpleCharStream
Position in buffer.

C

CDELIM - Static variable in interface org.biopcd.canvas.ValuesFileConstants
RegularExpression Id.
CHAR - Static variable in interface org.biopcd.canvas.ValuesFileConstants
RegularExpression Id.
close() - Method in class org.biopcd.canvas.PCDCanvas
Action for command buttons to close the window.
column - Variable in class org.biopcd.canvas.SimpleCharStream
 
curChar - Variable in class org.biopcd.canvas.ValuesFileTokenManager
 
currentToken - Variable in exception org.biopcd.canvas.ParseException
This is the last token that has been consumed successfully.

D

DCHAR - Static variable in interface org.biopcd.canvas.ValuesFileConstants
RegularExpression Id.
debugStream - Variable in class org.biopcd.canvas.ValuesFileTokenManager
Debug output.
DEFAULT - Static variable in interface org.biopcd.canvas.ValuesFileConstants
Lexical state.
disable_tracing() - Method in class org.biopcd.canvas.ValuesFile
Disable tracing.
display() - Method in class org.biopcd.canvas.PCDCanvas
Displays the command parameter window.
Done() - Method in class org.biopcd.canvas.SimpleCharStream
Reset buffer when finished.
DQEND - Static variable in interface org.biopcd.canvas.ValuesFileConstants
RegularExpression Id.
DQSTART - Static variable in interface org.biopcd.canvas.ValuesFileConstants
RegularExpression Id.
DQUOTE - Static variable in interface org.biopcd.canvas.ValuesFileConstants
Lexical state.

E

enable_tracing() - Method in class org.biopcd.canvas.ValuesFile
Enable tracing.
endColumn - Variable in class org.biopcd.canvas.Token
The column number of the last character of this Token.
endLine - Variable in class org.biopcd.canvas.Token
The line number of the last character of this Token.
EOF - Static variable in interface org.biopcd.canvas.ValuesFileConstants
End of File.
eol - Variable in exception org.biopcd.canvas.ParseException
The end of line string for this machine.
ExpandBuff(boolean) - Method in class org.biopcd.canvas.SimpleCharStream
 
expectedTokenSequences - Variable in exception org.biopcd.canvas.ParseException
Each entry in this array is an array of integers.

F

FillBuff() - Method in class org.biopcd.canvas.SimpleCharStream
 

G

generateParseException() - Method in class org.biopcd.canvas.ValuesFile
Generate ParseException.
getBeginColumn() - Method in class org.biopcd.canvas.SimpleCharStream
Get token beginning column number.
getBeginLine() - Method in class org.biopcd.canvas.SimpleCharStream
Get token beginning line number.
getColumn() - Method in class org.biopcd.canvas.SimpleCharStream
Deprecated.
getEndColumn() - Method in class org.biopcd.canvas.SimpleCharStream
Get token end column number.
getEndLine() - Method in class org.biopcd.canvas.SimpleCharStream
Get token end line number.
GetImage() - Method in class org.biopcd.canvas.SimpleCharStream
Get token literal value.
getLine() - Method in class org.biopcd.canvas.SimpleCharStream
Deprecated.
getMessage() - Method in error org.biopcd.canvas.TokenMgrError
You can also modify the body of this method to customize your error messages.
getNextToken() - Method in class org.biopcd.canvas.ValuesFile
Get the next Token.
getNextToken() - Method in class org.biopcd.canvas.ValuesFileTokenManager
Get the next Token.
getPluginName() - Method in class org.biopcd.canvas.PCDCanvas
Deprecated.
vestigial code from a previous BioLegato framework structure.
GetSuffix(int) - Method in class org.biopcd.canvas.SimpleCharStream
Get the suffix.
getTabSize(int) - Method in class org.biopcd.canvas.SimpleCharStream
 
getToken(int) - Method in class org.biopcd.canvas.ValuesFile
Get the specific Token.
getValue() - Method in class org.biopcd.canvas.Token
An optional attribute value of the Token.

I

image - Variable in class org.biopcd.canvas.Token
The string image of the token.
inBuf - Variable in class org.biopcd.canvas.SimpleCharStream
 
input_stream - Variable in class org.biopcd.canvas.ValuesFileTokenManager
 
inputStream - Variable in class org.biopcd.canvas.SimpleCharStream
 

J

jj_nt - Variable in class org.biopcd.canvas.ValuesFile
Next token.
jjFillToken() - Method in class org.biopcd.canvas.ValuesFileTokenManager
 
jjnewLexState - Static variable in class org.biopcd.canvas.ValuesFileTokenManager
Lex State array.
jjstrLiteralImages - Static variable in class org.biopcd.canvas.ValuesFileTokenManager
Token literal values.

K

kind - Variable in class org.biopcd.canvas.Token
An integer that describes the kind of this token.

L

LexicalError(boolean, int, int, int, String, char) - Static method in error org.biopcd.canvas.TokenMgrError
Returns a detailed message for the Error when it is thrown by the token manager to indicate a lexical error.
lexStateNames - Static variable in class org.biopcd.canvas.ValuesFileTokenManager
Lexer state names.
line - Variable in class org.biopcd.canvas.SimpleCharStream
 

M

main(String[]) - Static method in class org.biopcd.canvas.PCDCanvas
Starts BioLegato PCD canvas
maxNextCharInd - Variable in class org.biopcd.canvas.SimpleCharStream
 

N

newToken(int, String) - Static method in class org.biopcd.canvas.Token
Returns a new Token object, by default.
newToken(int) - Static method in class org.biopcd.canvas.Token
 
next - Variable in class org.biopcd.canvas.Token
A reference to the next regular (non-special) token from the input stream.

O

org.biopcd.canvas - package org.biopcd.canvas
 

P

parse(Map<String, Widget>) - Method in class org.biopcd.canvas.ValuesFile
Begin parsing the PCD values file.
parseColumn() - Method in class org.biopcd.canvas.ValuesFile
Parse a column/cell in a PCD values file.
ParseException - Exception in org.biopcd.canvas
This exception is thrown when parse errors are encountered.
ParseException(Token, int[][], String[]) - Constructor for exception org.biopcd.canvas.ParseException
This constructor is used by the method "generateParseException" in the generated parser.
ParseException() - Constructor for exception org.biopcd.canvas.ParseException
The following constructors are for use by you for whatever purpose you can think of.
ParseException(String) - Constructor for exception org.biopcd.canvas.ParseException
Constructor with message.
parseRow(Map<String, Widget>) - Method in class org.biopcd.canvas.ValuesFile
Parse a single row/line in a PCD values file.
PCDCanvas - Class in org.biopcd.canvas
The run window is used within the menu system to display options for running programs.
PCDCanvas() - Constructor for class org.biopcd.canvas.PCDCanvas
Creates a new instance of BioLegato's BioPCD canvas
PCDCanvas(Map<? extends Object, ? extends Object>) - Constructor for class org.biopcd.canvas.PCDCanvas
Creates a new instance of BioLegato's BioPCD canvas
PCDCanvas(String, Map<String, Widget>) - Constructor for class org.biopcd.canvas.PCDCanvas
Creates a new instance of BioLegato's BioPCD canvas
prevCharIsCR - Variable in class org.biopcd.canvas.SimpleCharStream
 
prevCharIsLF - Variable in class org.biopcd.canvas.SimpleCharStream
 

R

RDELIM - Static variable in interface org.biopcd.canvas.ValuesFileConstants
RegularExpression Id.
readChar() - Method in class org.biopcd.canvas.SimpleCharStream
Read a character.
readFile(String, Reader, boolean, boolean) - Method in class org.biopcd.canvas.PCDCanvas
Reads data into the canvas
readValues(Reader, Map<String, Widget>) - Static method in class org.biopcd.canvas.ValuesFile
Parse a PCD values file, and set all of the values for all widgets (with values specified in the file) contained in the map 'widgets'.
ReInit(Reader, int, int, int) - Method in class org.biopcd.canvas.SimpleCharStream
Reinitialise.
ReInit(Reader, int, int) - Method in class org.biopcd.canvas.SimpleCharStream
Reinitialise.
ReInit(Reader) - Method in class org.biopcd.canvas.SimpleCharStream
Reinitialise.
ReInit(InputStream, String, int, int, int) - Method in class org.biopcd.canvas.SimpleCharStream
Reinitialise.
ReInit(InputStream, int, int, int) - Method in class org.biopcd.canvas.SimpleCharStream
Reinitialise.
ReInit(InputStream, String) - Method in class org.biopcd.canvas.SimpleCharStream
Reinitialise.
ReInit(InputStream) - Method in class org.biopcd.canvas.SimpleCharStream
Reinitialise.
ReInit(InputStream, String, int, int) - Method in class org.biopcd.canvas.SimpleCharStream
Reinitialise.
ReInit(InputStream, int, int) - Method in class org.biopcd.canvas.SimpleCharStream
Reinitialise.
ReInit(InputStream) - Method in class org.biopcd.canvas.ValuesFile
Reinitialise.
ReInit(InputStream, String) - Method in class org.biopcd.canvas.ValuesFile
Reinitialise.
ReInit(Reader) - Method in class org.biopcd.canvas.ValuesFile
Reinitialise.
ReInit(ValuesFileTokenManager) - Method in class org.biopcd.canvas.ValuesFile
Reinitialise.
ReInit(SimpleCharStream) - Method in class org.biopcd.canvas.ValuesFileTokenManager
Reinitialise parser.
ReInit(SimpleCharStream, int) - Method in class org.biopcd.canvas.ValuesFileTokenManager
Reinitialise parser.

S

SCHAR - Static variable in interface org.biopcd.canvas.ValuesFileConstants
RegularExpression Id.
setDebugStream(PrintStream) - Method in class org.biopcd.canvas.ValuesFileTokenManager
Set debug output.
setTabSize(int) - Method in class org.biopcd.canvas.SimpleCharStream
 
SimpleCharStream - Class in org.biopcd.canvas
An implementation of interface CharStream, where the stream is assumed to contain only ASCII characters (without unicode processing).
SimpleCharStream(Reader, int, int, int) - Constructor for class org.biopcd.canvas.SimpleCharStream
Constructor.
SimpleCharStream(Reader, int, int) - Constructor for class org.biopcd.canvas.SimpleCharStream
Constructor.
SimpleCharStream(Reader) - Constructor for class org.biopcd.canvas.SimpleCharStream
Constructor.
SimpleCharStream(InputStream, String, int, int, int) - Constructor for class org.biopcd.canvas.SimpleCharStream
Constructor.
SimpleCharStream(InputStream, int, int, int) - Constructor for class org.biopcd.canvas.SimpleCharStream
Constructor.
SimpleCharStream(InputStream, String, int, int) - Constructor for class org.biopcd.canvas.SimpleCharStream
Constructor.
SimpleCharStream(InputStream, int, int) - Constructor for class org.biopcd.canvas.SimpleCharStream
Constructor.
SimpleCharStream(InputStream, String) - Constructor for class org.biopcd.canvas.SimpleCharStream
Constructor.
SimpleCharStream(InputStream) - Constructor for class org.biopcd.canvas.SimpleCharStream
Constructor.
specialToken - Variable in class org.biopcd.canvas.Token
This field is used to access special tokens that occur prior to this token, but after the immediately preceding regular (non-special) token.
SQEND - Static variable in interface org.biopcd.canvas.ValuesFileConstants
RegularExpression Id.
SQSTART - Static variable in interface org.biopcd.canvas.ValuesFileConstants
RegularExpression Id.
SQUOTE - Static variable in interface org.biopcd.canvas.ValuesFileConstants
Lexical state.
staticFlag - Static variable in class org.biopcd.canvas.SimpleCharStream
Whether parser is static.
SwitchTo(int) - Method in class org.biopcd.canvas.ValuesFileTokenManager
Switch to specified lex state.

T

tabSize - Variable in class org.biopcd.canvas.SimpleCharStream
 
Token - Class in org.biopcd.canvas
Describes the input token stream.
Token() - Constructor for class org.biopcd.canvas.Token
No-argument constructor
Token(int) - Constructor for class org.biopcd.canvas.Token
Constructs a new token for the specified Image.
Token(int, String) - Constructor for class org.biopcd.canvas.Token
Constructs a new token for the specified Image and Kind.
token - Variable in class org.biopcd.canvas.ValuesFile
Current token.
token_source - Variable in class org.biopcd.canvas.ValuesFile
Generated Token Manager.
tokenImage - Variable in exception org.biopcd.canvas.ParseException
This is a reference to the "tokenImage" array of the generated parser within which the parse error occurred.
tokenImage - Static variable in interface org.biopcd.canvas.ValuesFileConstants
Literal token values.
TokenMgrError - Error in org.biopcd.canvas
Token Manager Error.
TokenMgrError() - Constructor for error org.biopcd.canvas.TokenMgrError
No arg constructor.
TokenMgrError(String, int) - Constructor for error org.biopcd.canvas.TokenMgrError
Constructor with message and reason.
TokenMgrError(boolean, int, int, int, String, char, int) - Constructor for error org.biopcd.canvas.TokenMgrError
Full Constructor.
toString() - Method in class org.biopcd.canvas.Token
Returns the image.

U

UpdateLineColumn(char) - Method in class org.biopcd.canvas.SimpleCharStream
 

V

ValuesFile - Class in org.biopcd.canvas
File format parser for a PCD values file.
A PCD value file is specified as follows:
ValuesFile(InputStream) - Constructor for class org.biopcd.canvas.ValuesFile
Constructor with InputStream.
ValuesFile(InputStream, String) - Constructor for class org.biopcd.canvas.ValuesFile
Constructor with InputStream and supplied encoding
ValuesFile(Reader) - Constructor for class org.biopcd.canvas.ValuesFile
Constructor.
ValuesFile(ValuesFileTokenManager) - Constructor for class org.biopcd.canvas.ValuesFile
Constructor with generated Token Manager.
ValuesFileConstants - Interface in org.biopcd.canvas
Token literal values and constants.
ValuesFileTokenManager - Class in org.biopcd.canvas
Token Manager.
ValuesFileTokenManager(SimpleCharStream) - Constructor for class org.biopcd.canvas.ValuesFileTokenManager
Constructor.
ValuesFileTokenManager(SimpleCharStream, int) - Constructor for class org.biopcd.canvas.ValuesFileTokenManager
Constructor.

W

widgets - Variable in class org.biopcd.canvas.PCDCanvas
List of widgets for the window.
writeFile(String, Appendable, boolean) - Method in class org.biopcd.canvas.PCDCanvas
Writes data out from the canvas
WSP - Static variable in interface org.biopcd.canvas.ValuesFileConstants
RegularExpression Id.
A B C D E F G I J K L M N O P R S T U V W 
Skip navigation links
BioPCD canvas v1.1.0 API

Copyright © 2008-2022 University of Manitoba.