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

java.lang.Object
  extended by org.colos.ejs.library.control.ControlElement
      extended by org.colos.ejs.library.control.swing.ControlSwingElement
          extended by org.colos.ejs.library.control.swing.ControlDataTable
All Implemented Interfaces:
DataCollector, NeedsFinalUpdate, NeedsUpdate, Resetable

public class ControlDataTable
extends ControlSwingElement
implements NeedsUpdate, NeedsFinalUpdate, DataCollector, Resetable

A configurable control button. It will trigger an action when clicked. It has no internal value.


Field Summary
 
Fields inherited from class org.colos.ejs.library.control.swing.ControlSwingElement
ACTION_IMMEDIATE, ACTION_OFF, ACTION_ON, ACTION_PRESS, AXIS_DRAGGED_ACTION, BACKGROUND, ENABLED, FONT, FOREGROUND, KEY_ACTION, MENU_NAME, MOUSE_ENTERED_ACTION, MOUSE_EXITED_ACTION, MOUSE_MOVED_ACTION, PARENT, POSITION, PRINT_TARGET, SIZE, SWING_ELEMENT_NAME, TOOLTIP, VISIBLE
 
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
ControlDataTable()
           
 
Method Summary
 void finalUpdate()
           
 java.awt.Component getComponent()
          Returns the component of this ControlElement, the one that is added to a container.
 java.lang.String getDefaultValueString(int _index)
           
 java.lang.Object getObject()
          Returns the basic object that the ControlElement wrapps.
 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.
 void initialize()
          initializes the element.
 void onExit()
          perform any clean-up on exit
 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 or a primitive constant.
 void reset()
          resets the element
 void setDefaultValue(int _index)
           
 void setValue(int _index, Value _value)
          Sets the value of the registered variables.
 void update()
           
 
Methods inherited from class org.colos.ejs.library.control.swing.ControlSwingElement
changeVisual, getControlWindow, getMenuNameEntry, getTopWindow, getVisual, setControlWindow, toStringValue
 
Methods inherited from class org.colos.ejs.library.control.ControlElement
acceptsChild, addAction, addAction, addAction, addMenuEntries, destroy, editorIsReading, flush, getGroup, getObject, getProperty, getPropertyCommonName, getSimulation, getValue, implementsProperty, indexOf, invokeActions, invokeActions, isActive, propertyIndex, propertyIsTypeOf, propertyType, removeAction, removeAction, replaceVisual, setActive, setFieldListValue, setFieldListValues, setGroup, setProperties, setProperty, setProperty, setPropertyEditor, setVariableEditor, toString, variableChanged, variableChangedDoNotUpdate, variableExtraChanged, variablePropertiesClear, variablesChanged
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ControlDataTable

public ControlDataTable()
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

getObject

public java.lang.Object getObject()
Description copied from class: ControlElement
Returns the basic object that the ControlElement wrapps. Usually a graphic component

Overrides:
getObject in class ControlElement
Returns:
Object

getComponent

public java.awt.Component getComponent()
Description copied from class: ControlSwingElement
Returns the component of this ControlElement, the one that is added to a container.

Overrides:
getComponent in class ControlSwingElement

initialize

public void initialize()
Description copied from class: ControlElement
initializes the element. A kind of soft reset()

Overrides:
initialize in class ControlElement

reset

public void reset()
Description copied from class: ControlElement
resets the element

Overrides:
reset in class ControlElement

onExit

public void onExit()
Description copied from class: ControlElement
perform any clean-up on exit

Overrides:
onExit in class ControlElement

update

public void update()
Specified by:
update in interface NeedsUpdate

finalUpdate

public void finalUpdate()
Specified by:
finalUpdate in interface NeedsFinalUpdate

getPropertyList

public java.util.List<java.lang.String> getPropertyList()
Description copied from class: ControlSwingElement
Returns the list of all properties that can be set for this ControlElement. Subclasses that add properties should extend this table. Order is crucial here: Both for the presentation in an editor (f.i. ViewElement) and for the setValue() method.

Overrides:
getPropertyList in class ControlSwingElement

getPropertyInfo

public java.lang.String getPropertyInfo(java.lang.String _property)
Description copied from class: ControlSwingElement
Returns information about a given property. Subclasses that add properties should extend this table.
  • The first keyword is ALWAYS the type.
  • The keyword CONSTANT applies to properties that can not be changed using the setValue() methods

    Overrides:
    getPropertyInfo in class ControlSwingElement

  • parseConstant

    public Value parseConstant(java.lang.String _propertyType,
                               java.lang.String _value)
    Description copied from class: ControlSwingElement
    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 or a primitive constant. This method implements more cases than really needed for the base class. This is in order to save repetitions in swing subclasses.

    Overrides:
    parseConstant in class ControlSwingElement

    setValue

    public void setValue(int _index,
                         Value _value)
    Description copied from class: ControlSwingElement
    Sets the value of the registered variables. Subclasses with internal values should extend this

    Overrides:
    setValue in class ControlSwingElement

    setDefaultValue

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

    getValue

    public Value getValue(int _index)
    Description copied from class: ControlSwingElement
    Gets the value of any internal variable. Subclasses with internal values should extend this

    Overrides:
    getValue in class ControlSwingElement
    Returns:
    Value _value The object holding the value for the variable.

    getDefaultValueString

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