org.colos.ejs.library.control.drawables
Class ControlAnalyticScalarField
java.lang.Object
org.colos.ejs.library.control.ControlElement
org.colos.ejs.library.control.swing.ControlDrawable
org.colos.ejs.library.control.drawables.ControlDrawable2D
org.colos.ejs.library.control.drawables.ControlScalarField
org.colos.ejs.library.control.drawables.ControlAnalyticScalarField
- All Implemented Interfaces:
- NeedsPreUpdate
public class ControlAnalyticScalarField
- extends ControlScalarField
A set of arrows that implements a simpler 2D vector field
Method Summary |
java.lang.String |
getDefaultValueString(int _index)
|
java.lang.String |
getPropertyCommonName(java.lang.String _property)
This is used by Ejs to obtain an alias for the property
name in order to search for this alias in a common
file of easily translatable entries used in the tables
of properties for an element. |
java.lang.String |
getPropertyInfo(java.lang.String _property)
Returns information about a given property. |
java.util.List<java.lang.String> |
getPropertyList()
Returns the list of all properties that can be set for this
ControlElement. |
Value |
getValue(int _index)
Gets the value of any internal variable. |
Value |
parseConstant(java.lang.String _propertyType,
java.lang.String _value)
Checks if a value can be considered a valid constant value for a property
If not, it returns null, meaning the value can be considered to be
a GroupVariable |
void |
preupdate()
|
void |
setDefaultValue(int _index)
|
void |
setValue(int _index,
Value _value)
Sets the value of the registered variables. |
Methods inherited from class org.colos.ejs.library.control.ControlElement |
acceptsChild, addAction, addAction, addAction, editorIsReading, flush, getComponent, getGroup, getObject, getObject, getObjectClassname, getProperty, getSimulation, getValue, getVisual, implementsProperty, indexOf, initialize, invokeActions, invokeActions, isActive, onExit, propertyIndex, propertyIsTypeOf, propertyType, removeAction, removeAction, replaceVisual, reset, setActive, setFieldListValue, setFieldListValues, setGroup, setProperties, setProperty, setProperty, setPropertyEditor, setVariableEditor, toString, toStringValue, variableChanged, variableChangedDoNotUpdate, variableExtraChanged, variablePropertiesClear, variablesChanged |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
CARTESIAN
public static final int CARTESIAN
- See Also:
- Constant Field Values
POLAR
public static final int POLAR
- See Also:
- Constant Field Values
ControlAnalyticScalarField
public ControlAnalyticScalarField()
getPropertyList
public java.util.List<java.lang.String> getPropertyList()
- Description copied from class:
ControlElement
- Returns the list of all properties that can be set for this
ControlElement.
Subclasses that add properties should implement this.
Order is crucial here: Both for the presentation in an editor
(f.i. ViewElement) and for the setValue() method.
- Overrides:
getPropertyList
in class ControlScalarField
getPropertyCommonName
public java.lang.String getPropertyCommonName(java.lang.String _property)
- Description copied from class:
ControlElement
- This is used by Ejs to obtain an alias for the property
name in order to search for this alias in a common
file of easily translatable entries used in the tables
of properties for an element.
- Overrides:
getPropertyCommonName
in class ControlDrawable2D
- Parameters:
_property
- String
- Returns:
- String
getPropertyInfo
public java.lang.String getPropertyInfo(java.lang.String _property)
- Description copied from class:
ControlElement
- Returns information about a given property.
Subclasses that add properties should implement this.
Order in the implementation is irrelevant.
- The first keyword is ALWAYS the type. If more than one type is
accepted, they are separated by | (do NOT use spaces!)
- The keyword CONSTANT applies to properties that can not be
changed using the setValue() methods
- The keyword VARIABLE_EXPECTED is used when a String could be
accepted, but a variable has priority. In this case, a String requires
using inverted commas or quotes
- The keyword NotTrimmed specifies that leading or trailing
spaces must be respected when present. This is useful for labels or
titles, for instance
- The keywords PREVIOUS and POSTPROCESS indicate that,
when setting several properties at once (using setProperties()) the
property must be process before, resp. after, the others
- Overrides:
getPropertyInfo
in class ControlScalarField
parseConstant
public Value parseConstant(java.lang.String _propertyType,
java.lang.String _value)
- Description copied from class:
ControlElement
- Checks if a value can be considered a valid constant value for a property
If not, it returns null, meaning the value can be considered to be
a GroupVariable
- Overrides:
parseConstant
in class ControlScalarField
setValue
public void setValue(int _index,
Value _value)
- Description copied from class:
ControlElement
- Sets the value of the registered variables.
Subclasses with internal values should extend this
Order is crucial here: it must match exactly that of the getPropertyList()
method.
- Overrides:
setValue
in class ControlScalarField
setDefaultValue
public void setDefaultValue(int _index)
- Overrides:
setDefaultValue
in class ControlScalarField
getDefaultValueString
public java.lang.String getDefaultValueString(int _index)
- Overrides:
getDefaultValueString
in class ControlScalarField
getValue
public Value getValue(int _index)
- Description copied from class:
ControlElement
- Gets the value of any internal variable.
Subclasses with internal values should extend this
- Overrides:
getValue
in class ControlScalarField
- Returns:
- Value _value The object holding the value for the variable.
preupdate
public void preupdate()
- Specified by:
preupdate
in interface NeedsPreUpdate
- Overrides:
preupdate
in class ControlScalarField