org.colos.ejs.library.control.drawables
Class ControlVectorField

java.lang.Object
  org.colos.ejs.library.control.ControlElement
      org.colos.ejs.library.control.swing.ControlDrawable
          org.colos.ejs.library.control.drawables.ControlVectorField

All Implemented Interfaces:

NeedsPreUpdate

Direct Known Subclasses:

ControlAnalyticVectorField

public class ControlVectorField
extends ControlDrawable
implements NeedsPreUpdate

A set of arrows that implements a simpler 2D vector field

Field Summary

Fields inherited from class org.colos.ejs.library.control.swing.ControlDrawable

DRAWABLE_NAME, PARENT

Fields inherited from class org.colos.ejs.library.control.ControlElement

ACTION, ACTION_ERROR, ACTION_SUCCESS, METHOD_FOR_VARIABLE, METHOD_TRIGGER, NAME, VARIABLE_CHANGED

Constructor Summary

ControlVectorField()

Method Summary

java.lang.String	getDefaultValueString(int _index)
java.lang.String	getObjectClassname() Returns the expected class of the object that the ControlElement wrapps.
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	setExtrema(double min, double max)
void	setMaxColor(java.awt.Color _aColor)
void	setMinColor(java.awt.Color _aColor)
void	setNumberOfLevels(int _lev)
void	setParent(ControlParentOfDrawables _dp)
void	setValue(int _index, Value _value) Sets the value of the registered variables.

Methods inherited from class org.colos.ejs.library.control.swing.ControlDrawable

destroy, getDrawable, getMenuNameEntry, getParent, replaceDrawable

Methods inherited from class org.colos.ejs.library.control.ControlElement

acceptsChild, addAction, addAction, addAction, addMenuEntries, editorIsReading, flush, getComponent, getGroup, getObject, getObject, getProperty, getPropertyCommonName, 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

Constructor Detail

ControlVectorField

public ControlVectorField()

Method Detail

getObjectClassname

public java.lang.String getObjectClassname()

Description copied from class: ControlElement

Returns the expected class of the object that the ControlElement wrapps. Not final because of special needs (see display3d.DrawingPanel3D, f.i.)

Overrides:

getObjectClassname in class ControlElement

Returns:

Object

setParent

public void setParent(ControlParentOfDrawables _dp)

Overrides:

setParent in class ControlDrawable

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 ControlDrawable

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 ControlDrawable

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 ControlElement

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 ControlDrawable

setDefaultValue

public void setDefaultValue(int _index)

Overrides:

setDefaultValue in class ControlDrawable

getDefaultValueString

public java.lang.String getDefaultValueString(int _index)

Overrides:

getDefaultValueString in class ControlDrawable

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 ControlDrawable

Returns:

Value _value The object holding the value for the variable.

preupdate

public void preupdate()

Specified by:

preupdate in interface NeedsPreUpdate

setNumberOfLevels

public void setNumberOfLevels(int _lev)

setMinColor

public void setMinColor(java.awt.Color _aColor)

setMaxColor

public void setMaxColor(java.awt.Color _aColor)

setExtrema

public void setExtrema(double min,
                       double max)