org.colos.ejs.library.control.swing
Class ControlDrawable

java.lang.Object
  extended by org.colos.ejs.library.control.ControlElement
      extended by org.colos.ejs.library.control.swing.ControlDrawable
Direct Known Subclasses:
ControlComplexDataset, ControlDrawable2D, ControlDrawable3D, ControlElement2D, ControlHistogram, ControlVectorField, ControlVideo

public abstract class ControlDrawable
extends ControlElement

Abstract superclass for Drawables (children of ControlDrawableParent)


Field Summary
static int DRAWABLE_NAME
           
static int 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
ControlDrawable()
          Constructor and utilities
 
Method Summary
 void destroy()
          Clears any trace of myself (specially in the group)
 java.lang.String getDefaultValueString(int _index)
           
 Drawable getDrawable()
           
 java.lang.String getMenuNameEntry()
           
 ControlParentOfDrawables getParent()
           
 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.
 void replaceDrawable(Drawable _dr)
           
 void setDefaultValue(int _index)
           
 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.ControlElement
acceptsChild, addAction, addAction, addAction, addMenuEntries, editorIsReading, flush, getComponent, getGroup, getObject, getObject, getObjectClassname, getProperty, getPropertyCommonName, getSimulation, getValue, getVisual, implementsProperty, indexOf, initialize, invokeActions, invokeActions, isActive, onExit, parseConstant, 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
 

Field Detail

DRAWABLE_NAME

public static final int DRAWABLE_NAME
See Also:
Constant Field Values

PARENT

public static final int PARENT
See Also:
Constant Field Values
Constructor Detail

ControlDrawable

public ControlDrawable()
Constructor and utilities

Method Detail

getDrawable

public final Drawable getDrawable()

replaceDrawable

public final void replaceDrawable(Drawable _dr)

setParent

public void setParent(ControlParentOfDrawables _dp)

getParent

public final ControlParentOfDrawables getParent()

destroy

public void destroy()
Description copied from class: ControlElement
Clears any trace of myself (specially in the group)

Overrides:
destroy in class ControlElement

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.

Specified by:
getPropertyList in class ControlElement

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

    Specified by:
    getPropertyInfo in class ControlElement

  • getMenuNameEntry

    public java.lang.String getMenuNameEntry()

    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 ControlElement

    setDefaultValue

    public void setDefaultValue(int _index)
    Overrides:
    setDefaultValue in class ControlElement

    getDefaultValueString

    public java.lang.String getDefaultValueString(int _index)
    Overrides:
    getDefaultValueString in class ControlElement

    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 ControlElement
    Returns:
    Value _value The object holding the value for the variable.