cz.cuni.jagrlib.reg
Class InfoParam

java.lang.Object
  extended by cz.cuni.jagrlib.reg.InfoParam

public class InfoParam
extends Object

Parameter information.

Since:
0.25
Version:
0.26 $Rev: 440 $ $Date: 2007-05-05 14:14:56 +0200 (so, 05 V 2007) $ $Author: pepca $
Author:
PE, Jan Kostlivy
See Also:
InfoParam.java

Field Summary
 Object defaultValue
          Default value.
 String description
          Description of parameter.
 InfoParamGUI infoGUI
          Information about parameter's GUI.
static String IP_DESCR
          Description for combobox.
static String IP_MAXVALUE
          Maximum value of parameter.
static String IP_MINVALUE
          Minimum value of parameter.
static String IP_STRING
          Display text of item of combobox.
static String IP_TYPE
          Type of real value of item of combobox.
static String IP_TYPE_BOOLEAN
          Type of parameter - Boolean.
static String IP_TYPE_COMBO
          Type of parameter - Combo box.
static String IP_TYPE_DOUBLE
          Type of parameter - Double.
static String IP_TYPE_FLOAT
          Type of parameter - Float.
static String IP_TYPE_INTEGER
          Type of parameter - Integer.
static String IP_TYPE_LONG
          Type of parameter - Long.
static String IP_TYPE_MULTILINE
          Type of parameter - multi-line string.
static String IP_TYPE_SPEC
          Type of parameter - Special.
static String IP_TYPE_STRING
          Type of parameter - String.
static String IP_VALUE
          Real value of item of combobox.
static int MULTILINE_HEIGHT
          Multiline parameter height in lines.
 String name
          Name of parameter.
 Map<String,Object> nextInfo
          All other information goes here..
 InfoModule owner
          Owner of parameter.
 int propManip
          Manipulator type.
 String propManipClass
          Class-name for manipulation with special parameter (either fully-qualified or local in package cz.cuni.jagrlib.gui).
static String TI_PARAM
           
 String type
          Parameter type.
 Object value
          Parameter value.
 Vector<Map<String,Object>> values
          Valid values of the parameter.
 boolean visible
          Visible parameter (GUI editable).
 
Constructor Summary
InfoParam()
           
InfoParam(String _name, String _type, String _description, boolean _visible)
          Create a new InfoParam.
 
Method Summary
 void propEnd()
           
 void setBounds(Object min, Object max)
          Set parameter bounds.
 void setEnum(String label, Object value, String descr)
           
protected  String typeConvert(String newType)
           
 int visibleLines()
          Returns visible height in lines.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

IP_STRING

public static final String IP_STRING
Display text of item of combobox.

See Also:
Constant Field Values

IP_VALUE

public static final String IP_VALUE
Real value of item of combobox.

See Also:
Constant Field Values

IP_TYPE

public static final String IP_TYPE
Type of real value of item of combobox.

See Also:
Constant Field Values

IP_DESCR

public static final String IP_DESCR
Description for combobox.

See Also:
Constant Field Values

IP_MINVALUE

public static final String IP_MINVALUE
Minimum value of parameter.

See Also:
Constant Field Values

IP_MAXVALUE

public static final String IP_MAXVALUE
Maximum value of parameter.

See Also:
Constant Field Values

IP_TYPE_STRING

public static final String IP_TYPE_STRING
Type of parameter - String.

See Also:
Constant Field Values

IP_TYPE_MULTILINE

public static final String IP_TYPE_MULTILINE
Type of parameter - multi-line string.

See Also:
Constant Field Values

IP_TYPE_INTEGER

public static final String IP_TYPE_INTEGER
Type of parameter - Integer.

See Also:
Constant Field Values

IP_TYPE_LONG

public static final String IP_TYPE_LONG
Type of parameter - Long.

See Also:
Constant Field Values

IP_TYPE_FLOAT

public static final String IP_TYPE_FLOAT
Type of parameter - Float.

See Also:
Constant Field Values

IP_TYPE_DOUBLE

public static final String IP_TYPE_DOUBLE
Type of parameter - Double.

See Also:
Constant Field Values

IP_TYPE_COMBO

public static final String IP_TYPE_COMBO
Type of parameter - Combo box.

See Also:
Constant Field Values

IP_TYPE_BOOLEAN

public static final String IP_TYPE_BOOLEAN
Type of parameter - Boolean.

See Also:
Constant Field Values

IP_TYPE_SPEC

public static final String IP_TYPE_SPEC
Type of parameter - Special.

See Also:
Constant Field Values

TI_PARAM

public static final String TI_PARAM
See Also:
Constant Field Values

MULTILINE_HEIGHT

public static final int MULTILINE_HEIGHT
Multiline parameter height in lines.

See Also:
Constant Field Values

name

public String name
Name of parameter. Unique in one module.


type

public String type
Parameter type.


value

public Object value
Parameter value.


defaultValue

public Object defaultValue
Default value.


description

public String description
Description of parameter.


visible

public boolean visible
Visible parameter (GUI editable).


values

public Vector<Map<String,Object>> values
Valid values of the parameter.
Map contains HashMaps with information about combobox items: <String>, <Value>, <Type>
or boundary values (min, max).


propManip

public int propManip
Manipulator type.


propManipClass

public String propManipClass
Class-name for manipulation with special parameter (either fully-qualified or local in package cz.cuni.jagrlib.gui).


owner

public InfoModule owner
Owner of parameter. It can be InfoModule.


infoGUI

public InfoParamGUI infoGUI
Information about parameter's GUI.


nextInfo

public Map<String,Object> nextInfo
All other information goes here..

Constructor Detail

InfoParam

public InfoParam(String _name,
                 String _type,
                 String _description,
                 boolean _visible)
Create a new InfoParam.

Parameters:
_name - Name of parameter.
_type - Type of parameter (IP_TYPE_...).
_description - Description of parameter.
_visible - Will be this parameter visible in Skel (GUI)?

InfoParam

public InfoParam()
Method Detail

typeConvert

protected String typeConvert(String newType)

setBounds

public void setBounds(Object min,
                      Object max)
Set parameter bounds.


setEnum

public void setEnum(String label,
                    Object value,
                    String descr)

propEnd

public void propEnd()

visibleLines

public int visibleLines()
Returns visible height in lines.