|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcz.cuni.jagrlib.reg.RegPiece
public class RegPiece
Registration data for Piece.
Field Summary | |
---|---|
java.lang.String |
category
Module category. |
java.lang.String |
className
Local class name. |
java.lang.String |
description
Longer description of a module. |
java.lang.String |
name
Short name of a module. |
java.lang.String |
packageName
Fully qualified package name. |
protected InfoParam |
param
|
java.util.Map<java.lang.String,InfoParam> |
params
Set of module parameters. |
java.util.Map<java.lang.String,InfoPlug> |
plugs
Set of module plugs. |
java.lang.String |
template
Module template. |
static java.lang.Class<?> |
TYPE
Static instance of Class object for RegPiece. |
Constructor Summary | |
---|---|
RegPiece()
|
Method Summary | |
---|---|
java.lang.String |
fullClassName()
Returns full clas name of the module. |
protected void |
logError(java.lang.String msg)
|
void |
newInputPlug(java.lang.String key,
java.lang.String _inputInterface)
Connects a new input Plug . |
void |
newOptOutputPlug(java.lang.String key,
java.lang.String _outputInterface)
Connects a new optional output Plug . |
void |
newOutputPlug(java.lang.String key,
java.lang.String _outputInterface)
Connects a new output Plug . |
void |
newPlug(java.lang.String key,
boolean _mandatory,
boolean _multi,
boolean _cloneable,
java.lang.String _inputInterface,
java.lang.String _outputInterface)
Connects a new Plug . |
static java.lang.String |
normalizeInterfaceName(java.lang.String iface)
Separates local interface name from fully qualified class name. |
void |
propBegin(java.lang.String name,
java.lang.String type,
java.lang.String descr,
boolean visual)
Starts definition of single property. |
void |
propBounds(java.lang.Object min,
java.lang.Object max)
Minimum and maximum allowed values (for comparable types only, non-mandatory). |
void |
propDefault(java.lang.Object value)
Default value (non-mandatory). |
void |
propEnd()
Finishes definition of the property. |
void |
propEnum(java.lang.String label,
java.lang.Object value,
java.lang.String descr)
Adds next enum label (for list-box GUI). |
void |
propManipulator(int manipulatorType)
Sets visual manipulator for GUI editing of the property. |
void |
propManipulator(java.lang.String className)
Sets visual manipulator for GUI editing of the property. |
void |
setRegStrings(java.lang.String _name,
java.lang.String _template,
java.lang.String _category,
java.lang.String _description)
Sets registration strings for the module. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public java.lang.String packageName
public java.lang.String className
public java.lang.String name
public java.lang.String template
public java.lang.String category
public java.lang.String description
public java.util.Map<java.lang.String,InfoPlug> plugs
public java.util.Map<java.lang.String,InfoParam> params
protected InfoParam param
public static final java.lang.Class<?> TYPE
Constructor Detail |
---|
public RegPiece()
Method Detail |
---|
public static final java.lang.String normalizeInterfaceName(java.lang.String iface)
public final java.lang.String fullClassName()
public void newPlug(java.lang.String key, boolean _mandatory, boolean _multi, boolean _cloneable, java.lang.String _inputInterface, java.lang.String _outputInterface)
Plug
.
General routine.
newPlug
in interface Template
key
- New plug's key._mandatory
- Is that plug mandatory (has to be connected)?_multi
- Can that plug be used in multi-channels?_cloneable
- Is that plug "cloneable" (=generic)? If yes,
ordinal numbers (starting from 0) will be appended to its name._inputInterface
- Fully qualified identifier of input (implemented)
interface
._outputInterface
- Fully qualified identifier of output (required)
interface
.public void newInputPlug(java.lang.String key, java.lang.String _inputInterface)
Plug
. Common-use routine: creates optional,
non-cloneable, multi plug.
newInputPlug
in interface Template
key
- New plug's key._inputInterface
- Fully qualified identifier of input (implemented)
interface
.public void newOutputPlug(java.lang.String key, java.lang.String _outputInterface)
Plug
.
Common-use routine: creates mandatory, non-cloneable, multi plug.
newOutputPlug
in interface Template
key
- New plug's key._outputInterface
- Fully qualified identifier of output (required)
interface
.public void newOptOutputPlug(java.lang.String key, java.lang.String _outputInterface)
Plug
.
Common-use routine: creates optional, non-cloneable, multi plug.
newOptOutputPlug
in interface Template
key
- New plug's key._outputInterface
- Fully qualified identifier of output (required)
interface
.public void setRegStrings(java.lang.String _name, java.lang.String _template, java.lang.String _category, java.lang.String _description)
setRegStrings
in interface Template
protected void logError(java.lang.String msg)
public void propBegin(java.lang.String name, java.lang.String type, java.lang.String descr, boolean visual)
propBegin
in interface Template
name
- String identifier (unique inside one module class).type
- Value type - full Java class identifier.descr
- Brief textual description (for human eyes only).visual
- Should be this property represented visually in GUI?propEnd()
public void propDefault(java.lang.Object value)
propDefault
in interface Template
public void propBounds(java.lang.Object min, java.lang.Object max)
propBounds
in interface Template
public void propManipulator(int manipulatorType)
propManipulator
in interface Template
public void propManipulator(java.lang.String className)
propManipulator
in interface Template
className
- Class name (either fully-qualified or local in package cz.cuni.jagrlib.gui
).public void propEnum(java.lang.String label, java.lang.Object value, java.lang.String descr)
propEnum
in interface Template
label
- Textual label to appear in the listbox.value
- Associated property value (real-value).descr
- Optional item's description (for human eyes only).public void propEnd()
propBegin(java.lang.String, java.lang.String, java.lang.String, boolean)
must
be properly closed by propEnd()
.
propEnd
in interface Template
propBegin(java.lang.String, java.lang.String, java.lang.String, boolean)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |