org.opensourcephysics.ejs.control.swing
Class ControlFrame

java.lang.Object
  org.opensourcephysics.ejs.control.ControlElement
      org.opensourcephysics.ejs.control.swing.ControlSwingElement
          org.opensourcephysics.ejs.control.swing.ControlContainer
              org.opensourcephysics.ejs.control.swing.ControlWindow
                  org.opensourcephysics.ejs.control.swing.ControlFrame

All Implemented Interfaces:

NeedsUpdate

public class ControlFrame
extends ControlWindow

A configurable Frame. It has no internal value, nor can trigger any action.

Field Summary

protected javax.swing.JFrame

frame

Fields inherited from class org.opensourcephysics.ejs.control.swing.ControlWindow

internalValue, shouldShow, startingup, VISIBLE, waitForReset

Fields inherited from class org.opensourcephysics.ejs.control.swing.ControlContainer

children, radioButtons

Fields inherited from class org.opensourcephysics.ejs.control.swing.ControlSwingElement

ACTION_OFF, ACTION_ON, ACTION_PRESS, BACKGROUND, ENABLED, FONT, FOREGROUND, myVisual, PARENT, POSITION, TOOLTIP

Fields inherited from class org.opensourcephysics.ejs.control.ControlElement

ACTION, isUnderEjs, METHOD_FOR_VARIABLE, METHOD_TRIGGER, myGroup, myObject, myPropertiesTable, VARIABLE_CHANGED

Constructor Summary

ControlFrame(java.lang.Object _visual)
Constructor ControlFrame

Method Summary

protected java.awt.Component	createVisual(java.lang.Object _visual) Creates the visual component of this ControlElement, the one you can configure graphically.
java.awt.Component	getComponent() Returns the component of this ControlElement, the one that is added to a container.
java.awt.Container	getContainer()
java.lang.String	getPropertyInfo(java.lang.String _property) Returns information about a given property.
java.util.ArrayList<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	setDefaultValue(int _index)
void	setValue(int _index, Value _value) Sets the value of the registered variables.

Methods inherited from class org.opensourcephysics.ejs.control.swing.ControlWindow

adjustSize, destroy, dispose, hide, reset, setWaitForReset, show, update

Methods inherited from class org.opensourcephysics.ejs.control.swing.ControlContainer

add, getChildren, informRadioGroup, remove, setProperty

Methods inherited from class org.opensourcephysics.ejs.control.swing.ControlSwingElement

getIcon, getVisual, parseConstant

Methods inherited from class org.opensourcephysics.ejs.control.ControlElement

addAction, addAction, addAction, getGroup, getObject, getProperty, getSimulation, implementsProperty, initialize, invokeActions, invokeActions, isActive, propertyIsTypeOf, propertyType, removeAction, removeAction, setActive, setGroup, setProperties, toString, variableChanged, variableChangedDoNotUpdate, variablePropertiesClear, variablesChanged

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

frame

protected javax.swing.JFrame frame

Constructor Detail

ControlFrame

public ControlFrame(java.lang.Object _visual)

Constructor ControlFrame

Parameters:

_visual -

Method Detail

createVisual

protected java.awt.Component createVisual(java.lang.Object _visual)

Description copied from class: ControlSwingElement

Creates the visual component of this ControlElement, the one you can configure graphically. If an object of an appropriate class is provided, it is used as the visual.

Specified by:

createVisual in class ControlSwingElement

Parameters:

_visual - The javax.swing.JComponent to be wrapped

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

getContainer

public java.awt.Container getContainer()

Overrides:

getContainer in class ControlContainer

getPropertyList

public java.util.ArrayList<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 ControlWindow

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

The keyword BASIC is used by Ejs to group properties to the left hand side of the property editor

The keyword HIDDEN is used by Ejs so that it does not display an entry in the editor field

Overrides:

getPropertyInfo in class ControlWindow

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 ControlWindow

Parameters:

_index - A keyword index that distinguishes among variables

_value - The object holding the value for the variable.

setDefaultValue

public void setDefaultValue(int _index)

Overrides:

setDefaultValue in class ControlWindow

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 ControlWindow

Parameters:

_index - A keyword index that distinguishes among variables

Returns:

Value _value The object holding the value for the variable.