| Overview | Package | Class | Tree | Index | Help | NetCharts Pro (Applets) 7.0 | ||
| PREV CLASS | NEXT CLASS | FRAMES | NO FRAMES | ||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||
java.lang.Object
|
+--java.util.Observable
|
+--netcharts.util.NFParam
| Constructor Summary | |
| NFParam()
Create a new parameter parser, with no associated applet. | |
| NFParam(java.applet.Applet app)
Create a new parameter parser. | |
| NFParam(java.applet.Applet app,
java.awt.Component comp)
Create a new parameter parser. | |
| Method Summary | |
| void | addObserver(java.util.Observer observer)
Add the given observer to the list of observers for this object. |
| boolean | changed(java.lang.String param)
Returns true if the parameter has been changed since "get" was last called. |
| void | clean()
Cleans the parameter database for reuse. |
| void | defineActiveLabel(java.lang.String param)
Create a parser definition for an ActiveLabel tuple. |
| int | defineActiveLabel(java.lang.String param,
java.util.Vector v)
Append the parser elements for an ActiveLabel to the given vector. |
| void | defineAlias(java.lang.String alias,
java.lang.String param)
Define an alias for param. |
| NFParamDef | defineArrow(java.lang.String param)
Create a parser definition for a arrow. |
| int | defineArrow(java.lang.String param,
java.util.Vector v)
Append the parameters needed for a line to the given vector. |
| NFParamDef | defineBorderCornerType(java.lang.String param,
int type)
Create a parser definition for border corner type and assign the given type as the default. |
| NFParamDef | defineBorderType(java.lang.String param,
int type)
Create a parser definition for border type and assign the given type as the default. |
| NFParamDef | defineColor(java.lang.String param)
Define a Color parameter. |
| NFParamDef | defineColor(java.lang.String param,
java.awt.Color color)
Define a Color parameter with the given default color. |
| void | defineColorExpression(java.lang.String param,
java.util.Vector v,
java.awt.Color defaultColor)
Create a parser definition for a color expression. |
| NFParamDef | defineDate(java.lang.String param)
Define a Date parameter. |
| NFParamDef | defineDate(java.lang.String param,
java.lang.Object obj)
Define a Date parameter, with the given default object which may be any of the following types:
|
| NFParamDef | defineGraphSymbol(java.lang.String param)
Create a parser definition for a graph symbol. |
| int | defineGraphSymbol(java.lang.String param,
java.util.Vector v)
Append the parameters needed for a graph symbol to the given vector. |
| NFParamDef | defineImage(java.lang.String param)
Define a Image parameter with the given image URL. |
| NFParamDef | defineImageType(java.lang.String param,
int type)
Create a parser definition for image type and assign the given type as the default. |
| NFParamDef | defineLabel(java.lang.String param)
Create a parser definition for a label. |
| NFParamDef | defineLabel(java.lang.String param,
boolean includeJustify)
Create a parser definition for a label. |
| NFParamDef | defineLabel(java.lang.String param,
boolean includeJustify,
boolean includeExternalJustify)
Create a parser definition for a label. |
| NFParamDef | defineLabel(java.lang.String param,
boolean includeAngle,
boolean includeJustify,
boolean includeExternalJustify)
Create a parser definition for a label. |
| NFParamDef | defineLabel(java.lang.String param,
boolean includeAngle,
boolean includeJustify,
boolean includeExternalJustify,
boolean includeExtend)
Create a parser definition for a label. |
| int | defineLabel(java.lang.String param,
java.util.Vector v)
Append the parser elements for a label to the given vector. |
| int | defineLabel(java.lang.String param,
java.util.Vector v,
boolean includeJustify)
Append the parser elements for a label to the given vector. |
| int | defineLabel(java.lang.String param,
java.util.Vector v,
boolean includeJustify,
boolean includeExternalJustify)
Append the parser elements for a label to the given vector. |
| NFParamDef | defineLine(java.lang.String param)
Create a parser definition for a line |
| int | defineLine(java.lang.String param,
java.util.Vector v)
Append the parameters needed for a line to the given vector. |
| NFParamDef | defineLineStyle(java.lang.String param,
int defValue)
Returns a parameter definition for a line style, using the given default value and parameter name. |
| NFParamDef | defineNumber(java.lang.String param)
Define a Number parameter, with a null initial value. |
| NFParamDef | defineNumber(java.lang.String param,
java.lang.Number val)
Define a Number parameter, with a given initial value. |
| NFParamDef | defineRegion(java.lang.String param)
Create a parser definition for a background region. |
| int | defineRegion(java.lang.String param,
java.util.Vector v)
Append the parameters needed for a region to the given vector. |
| NFParamDef | defineString(java.lang.String param)
Define a String parameter, with a null initial value. |
| NFParamDef | defineString(java.lang.String param,
java.lang.String val)
Define a String parameter, with a given initial value. |
| NFParamDef | defineSymbol(java.lang.String param,
java.util.Hashtable symtable)
Define a Symbol parameter, with the given SYMTABLE containing all valid keywords and their associated values. |
| NFParamDef | defineSymbol(java.lang.String param,
java.util.Hashtable symtable,
java.lang.Object val)
Define a Symbol parameter, with the given SYMTABLE containing all valid keywords and their associated values. |
| NFParamDef | defineTuple(java.lang.String param,
java.util.Vector defs)
This method defines the parameter as a tuple (one or more elements). |
| NFParamDef | defineTuple(java.lang.String param,
java.util.Vector defs,
boolean varLength)
Defines a tuple definition which supports a variable number of items. |
| void | defineVector(java.lang.String param,
NFParamDef item)
Define a vector of values for the given parameter. |
| static void | doEscapes(java.lang.String str,
java.lang.StringBuffer buf)
This method appends the given string to the given string buffer, with all special characters escaped. |
| boolean | exists(java.lang.String param)
Returns true if the parameter has been defined. |
| java.lang.Object | get(java.lang.String param)
Returns the value of the given parameter. |
| double | getChartScale()
Returns the currently defined Chart ScaleFactor value. |
| java.util.Vector | getChildKeys(java.lang.String parentName)
Return a list of all the parameters defined within a TUPLE or VECTOR. |
| NFContext | getContext()
Get the context of this NFParam object. |
| java.util.Enumeration | getKeys()
Returns a list of all the keys in the parameter hashtable |
| NFParamDef | getParamDef(java.lang.String param)
Get the parameter definition for the named parameter. |
| java.lang.Object | getParamExpr(java.lang.String param)
Returns the databean (if any) associated with the given parameter. |
| java.util.Vector | getPrimaryKeys(java.util.Vector v)
Returns a list of keys for the parameters that are *NOT* part of a tuple or vector. |
| java.util.Enumeration | getSymbolKeys(java.lang.String symbolName)
Returns the possible values for the given symbol. |
| java.lang.Object | getValue(NFParamDef def)
Get the value of the given parameter definition. |
| void | remove(java.lang.String param)
Removes the given parameter from the parameter table |
| void | setChanged(java.lang.String param)
Changes the state of the given parameter to indicate that clients should reread the parameter. |
| void | setContext(NFContext context)
Set the context of this NParam object. |
| static void | undoEscapes(java.lang.String str,
java.lang.StringBuffer buf)
This method processes the given string and replaces all escape sequences with the appropriate special character and appends it to the string buffer. |
| void | update()
This method should be called whenever a batch of parameters have been changed in order to notify all of the observers for the current NFParam object. |
| Constructor Detail |
public NFParam()
public NFParam(java.applet.Applet app)
public NFParam(java.applet.Applet app,
java.awt.Component comp)
| Method Detail |
public void setContext(NFContext context)
context
- The context to set.public NFContext getContext()
public void addObserver(java.util.Observer observer)
observer
- The new observer to add.
public NFParamDef getParamDef(java.lang.String param)
throws NFParamException
param
- The paramater name.
public java.lang.Object getParamExpr(java.lang.String param)
throws NFParamException
param
- The paramater name.public boolean exists(java.lang.String param)
param
- The paramater name.public boolean changed(java.lang.String param)
param
- The paramater name.public void setChanged(java.lang.String param)
param
- The paramater name.
public java.lang.Object get(java.lang.String param)
throws NFParamException
param
- The paramater name.public void remove(java.lang.String param)
param
- The paramater name.public java.util.Enumeration getKeys()
public java.util.Vector getPrimaryKeys(java.util.Vector v)
v
- The vector to place the keys into.
public java.util.Vector getChildKeys(java.lang.String parentName)
throws NFParamException
parentName
- The name of the primary key for which the child keys
are defined.
public java.util.Enumeration getSymbolKeys(java.lang.String symbolName)
throws NFParamException
The
- symbol name.
public static void doEscapes(java.lang.String str,
java.lang.StringBuffer buf)
str
- The string to escape.
buf
- The buffer to append the escaped string to.
public static void undoEscapes(java.lang.String str,
java.lang.StringBuffer buf)
str
- The string to unescape.
buf
- The buffer to append the unescaped string to.public java.lang.Object getValue(NFParamDef def)
def
- The paramater definition.public void update()
public NFParamDef defineLabel(java.lang.String param)
param
- The paramater name.
public NFParamDef defineLabel(java.lang.String param,
boolean includeJustify)
param
- The paramater name.
includeJustify
- Whether to include the internal justification element.
public NFParamDef defineLabel(java.lang.String param,
boolean includeJustify,
boolean includeExternalJustify)
param
- The paramater name.
includeJustify
- Whether to include the internal justification element.
includeExternalJustify
- Whether to include the external justification element.
public NFParamDef defineLabel(java.lang.String param,
boolean includeAngle,
boolean includeJustify,
boolean includeExternalJustify)
param
- The paramater name.
includeAngle
- Whether to include the angle element.
includeJustify
- Whether to include the internal justification element.
includeExternalJustify
- Whether to include the external justification element.
public NFParamDef defineLabel(java.lang.String param,
boolean includeAngle,
boolean includeJustify,
boolean includeExternalJustify,
boolean includeExtend)
param
- The paramater name.
includeAngle
- Whether to include the angle element.
includeJustify
- Whether to include the internal justification element.
includeExternalJustify
- Whether to include the external justification element.
includeExtend
- Whether to include the extend element.
public int defineLabel(java.lang.String param,
java.util.Vector v)
param
- The paramater name.
v
- The current tuple definition.
public int defineLabel(java.lang.String param,
java.util.Vector v,
boolean includeJustify)
param
- The paramater name.
v
- The current tuple definition.
includeJustify
- Whether to include the internal justification element.
public int defineLabel(java.lang.String param,
java.util.Vector v,
boolean includeJustify,
boolean includeExternalJustify)
param
- The paramater name.
v
- The current tuple definition.
includeJustify
- Whether to include the internal justification element.
includeExternalJustify
- Whether to include the external justification element.
public void defineColorExpression(java.lang.String param,
java.util.Vector v,
java.awt.Color defaultColor)
param
- The parameter name.
v
- The current tuple definition.
defaultColor
- public NFParamDef defineRegion(java.lang.String param)
param
- The paramater name.
public int defineRegion(java.lang.String param,
java.util.Vector v)
param
- The paramater name.
v
- The current tuple definition.public void defineActiveLabel(java.lang.String param)
param
- The paramater name.
public int defineActiveLabel(java.lang.String param,
java.util.Vector v)
v
- The current tuple definition.
param
- The paramater name.public NFParamDef defineString(java.lang.String param)
param
- The paramater name.
public NFParamDef defineString(java.lang.String param,
java.lang.String val)
param
- The paramater name.
val
- The initial paramater value.public NFParamDef defineNumber(java.lang.String param)
param
- The paramater name.
public NFParamDef defineNumber(java.lang.String param,
java.lang.Number val)
val
- The initial paramater value.
param
- The paramater name.public NFParamDef defineColor(java.lang.String param)
param
- The paramater name.
public NFParamDef defineColor(java.lang.String param,
java.awt.Color color)
color
- The initial paramater value.
param
- The paramater name.
public NFParamDef defineSymbol(java.lang.String param,
java.util.Hashtable symtable)
param
- The paramater name.
symtable
- The symbol mappings.
public NFParamDef defineSymbol(java.lang.String param,
java.util.Hashtable symtable,
java.lang.Object val)
param
- The paramater name.
symtable
- The symbol mappings.
val
- The initial paramater value.
public NFParamDef defineTuple(java.lang.String param,
java.util.Vector defs)
Vector tuple = new Vector();
tuple.addElement (defineString ("Fred1"));
tuple.addElement (defineNumber ("Fred2"));
tuple.addElement (defineSymbol ("Fred3", new Hashtable()));
defineTuple ("Fred", tuple);
defines a three-element tuple for the "Fred" parameter, in which
the first element is a String, the second is a Number and the
third is a Symbol, with an empty symbol table.
When parsed, the tuple elements may be separated by whitespace
or commas. Leading and trailing parenthesis are optional, except
when a tuple is contained within a vector, then they are mandatory.
param
- The paramater name.
defs
- The tuple's child definitions.
public NFParamDef defineTuple(java.lang.String param,
java.util.Vector defs,
boolean varLength)
param
- The paramater name.
defs
- The tuple's child definitions.
varLength
- Whether the tuple is variable length.
public void defineVector(java.lang.String param,
NFParamDef item)
Vector tuple = new Vector();
tuple.addElement (defineString ("Fred1"));
tuple.addElement (defineNumber ("Fred2"));
defineVector ("Fred", defineTuple ("FredItem", tuple));
defines a vector for the "Fred" parameter, in which each element
is a two-item tuple, containing a String and a Number.
The following code:
defineVector ("Sally", defineString ("SallyItem"));
defines a vector of String items named "Sally".
param
- The paramater name.
item
- The paramater definition.
public void defineAlias(java.lang.String alias,
java.lang.String param)
alias
- The name of the alias.
param
- The name of the parameter to alias.public NFParamDef defineImage(java.lang.String param)
param
- The paramater name.public NFParamDef defineDate(java.lang.String param)
param
- The paramater name.
public NFParamDef defineDate(java.lang.String param,
java.lang.Object obj)
param
- The paramater name.
obj
- The initial paramater value.
public NFParamDef defineBorderType(java.lang.String param,
int type)
param
- The paramater name.
type
- The initial paramater value.
public NFParamDef defineBorderCornerType(java.lang.String param,
int type)
param
- The paramater name.
type
- The initial paramater value.
public NFParamDef defineImageType(java.lang.String param,
int type)
param
- The paramater name.
type
- The initial paramater value.public NFParamDef defineGraphSymbol(java.lang.String param)
param
- The paramater name.
public int defineGraphSymbol(java.lang.String param,
java.util.Vector v)
param
- The paramater name.
v
- The current tuple definition.public NFParamDef defineLine(java.lang.String param)
param
- The paramater name.
public int defineLine(java.lang.String param,
java.util.Vector v)
param
- The paramater name.
v
- The current tuple definition.
public NFParamDef defineLineStyle(java.lang.String param,
int defValue)
param
- The paramater name.
defValue
- The initial paramater value.public NFParamDef defineArrow(java.lang.String param)
param
- The paramater name.
public int defineArrow(java.lang.String param,
java.util.Vector v)
param
- The paramater name.
v
- The current tuple definition.public double getChartScale()
public void clean()
| Overview | Package | Class | Tree | Index | Help | |||
| PREV CLASS | NEXT CLASS | FRAMES | NO FRAMES | ||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||
| Visual Mining, Inc. | Copyright © Visual Mining, Inc. 1996 - 2010 |
Last Modified: Jun 29, 2010 |