org.opensourcephysics.ejs.control.swing
Class ControlWindow

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

All Implemented Interfaces:

NeedsUpdate

Direct Known Subclasses:

ControlDialog, ControlFrame

public abstract class ControlWindow
extends ControlContainer
implements NeedsUpdate

A configurable Window. Base class for Frame and Dialog

Field Summary

protected BooleanValue	internalValue
static int	NAME
protected boolean	shouldShow
protected boolean	startingup
static int	VISIBLE
protected boolean	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

ControlWindow(java.lang.Object _visual)

Method Summary

void	adjustSize()
void	destroy() Clears any trace of myself (specially in the group)
void	dispose()
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	hide()
void	reset() resets the element
void	setDefaultValue(int _index)
void	setValue(int _index, Value _value) Sets the value of the registered variables.
void	setWaitForReset(boolean _option)
void	show()
void	update()

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

add, getChildren, getContainer, informRadioGroup, remove, setProperty

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

createVisual, getComponent, 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

NAME

public static final int NAME

See Also:

Constant Field Values

VISIBLE

public static final int VISIBLE

See Also:

Constant Field Values

internalValue

protected BooleanValue internalValue

waitForReset

protected boolean waitForReset

startingup

protected boolean startingup

shouldShow

protected boolean shouldShow

Constructor Detail

ControlWindow

public ControlWindow(java.lang.Object _visual)

Method Detail

dispose

public void dispose()

show

public void show()

hide

public void hide()

destroy

public void destroy()

Description copied from class: ControlElement

Clears any trace of myself (specially in the group)

Overrides:

destroy in class ControlElement

setWaitForReset

public void setWaitForReset(boolean _option)

reset

public void reset()

Description copied from class: ControlElement

resets the element

Overrides:

reset in class ControlElement

update

public void update()

Specified by:

update in interface NeedsUpdate

adjustSize

public void adjustSize()

Overrides:

adjustSize 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 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

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 ControlContainer

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

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 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

Parameters:

_index - A keyword index that distinguishes among variables

Returns:

Value _value The object holding the value for the variable.