plugins.adufour.vars.gui.swing
Class MutableVarEditor

java.lang.Object
  plugins.adufour.vars.gui.VarEditor<V>
      plugins.adufour.vars.gui.swing.SwingVarEditor<java.lang.Object>
          plugins.adufour.vars.gui.swing.MutableVarEditor

All Implemented Interfaces:

VarListener<java.lang.Object>

public class MutableVarEditor
extends SwingVarEditor<java.lang.Object>

Special editor that changes type according to the underlying variable

Author:

Alexandre Dufour

Field Summary

Fields inherited from class plugins.adufour.vars.gui.VarEditor

variable

Constructor Summary

MutableVarEditor(VarMutable variable)

Method Summary

protected void	activateListeners() Activates listeners on the editor component.
protected javax.swing.JComponent	createEditorComponent() Creates the component to display on the graphical user interface, allowing the user to modify the variable's value via appropriate listeners (listeners should be added or removed via the VarEditor.activateListeners() and VarEditor.deactivateListeners() methods). In order to allow multiple editors to modify the same variable, this method should always return a newly constructed component (by Swing design, a same component can only be used once per interface). Once created, the component is stored in the final VarEditor.editorComponent field to avoid unnecessary re-creations (e.g.
protected void	deactivateListeners() Deactivates listeners on the editor component.
void	dispose() Dispose of resources (e.g.
double	getComponentVerticalResizeFactor() Indicates whether and how this component should resize vertically if the container panel allows resizing.
javax.swing.JComponent	getEditorComponent()
java.awt.Dimension	getPreferredSize()
boolean	isComponentEnabled()
boolean	isComponentOpaque()
boolean	isComponentResizeable()
void	setComponentToolTipText(java.lang.String s)
protected void	setEditorEnabled(boolean enabled)
void	setEnabled(boolean enabled) Enables (or disables) the graphical component associated with the Variable object.
protected void	updateInterfaceValue() Updates the graphical interface component to reflect the new value of the underlying variable (accessible via the Var.getValue() method).

Methods inherited from class plugins.adufour.vars.gui.VarEditor

getComponentHorizontalResizeFactor, getVariable, isComponentFocusable, isNameVisible, referenceChanged, setComponentFocusable, setComponentResizeable, setNameVisible, valueChanged

Methods inherited from class java.lang.Object

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

Constructor Detail

MutableVarEditor

public MutableVarEditor(VarMutable variable)

Method Detail

createEditorComponent

protected javax.swing.JComponent createEditorComponent()

Description copied from class: VarEditor

Creates the component to display on the graphical user interface, allowing the user to modify the variable's value via appropriate listeners (listeners should be added or removed via the VarEditor.activateListeners() and VarEditor.deactivateListeners() methods).
In order to allow multiple editors to modify the same variable, this method should always return a newly constructed component (by Swing design, a same component can only be used once per interface).
Once created, the component is stored in the final VarEditor.editorComponent field to avoid unnecessary re-creations (e.g. during interface refresh). To bypass this optimization and force the creation of a new component for every interface refresh, consider overriding the VarEditor.getEditorComponent() method.

WARNING: this method is called within the VarEditor.VarEditor(Var) constructor, therefore all instance fields besides the final VarEditor.variable field will be null until this method returns.

Specified by:

createEditorComponent in class SwingVarEditor<java.lang.Object>

Returns:

a graphical input component that is linked to the variable and can be used to view or adjust the variable value

dispose

public void dispose()

Description copied from class: VarEditor

Dispose of resources (e.g. listeners, IO etc.) before releasing the editor. This method must be called by overriding implementations to ensure proper cleaning

Overrides:

dispose in class VarEditor<java.lang.Object>

getEditorComponent

public javax.swing.JComponent getEditorComponent()

Overrides:

getEditorComponent in class SwingVarEditor<java.lang.Object>

Returns:

the graphical component used to view or modify the variable's value. By default, the returned component is the one created by the VarEditor.createEditorComponent() method during object construction. This method can be overridden to return a new component for each call (note however that this method may be called many times, e.g. during interface refresh)

getPreferredSize

public java.awt.Dimension getPreferredSize()

Overrides:

getPreferredSize in class SwingVarEditor<java.lang.Object>

Returns:

The preferred dimension of the local VarEditor.editorComponent. By default, this method calls the component's JComponent.getPreferredSize() method. However, this method can be overridden to provide a custom dimension, e.g. to fix the size of the component regardless of its content

isComponentOpaque

public boolean isComponentOpaque()

Overrides:

isComponentOpaque in class SwingVarEditor<java.lang.Object>

Returns:

true if the editor is opaque, or false if the component is transparent. This method can be overridden to force the opacity to a given state

isComponentEnabled

public boolean isComponentEnabled()

Overrides:

isComponentEnabled in class SwingVarEditor<java.lang.Object>

Returns:

true if the editor is enabled, i.e. whether the graphical component is active and may receive user input. This method can be overridden to force the editor status to a given state

setComponentToolTipText

public void setComponentToolTipText(java.lang.String s)

Overrides:

setComponentToolTipText in class SwingVarEditor<java.lang.Object>

activateListeners

protected void activateListeners()

Description copied from class: VarEditor

Activates listeners on the editor component. Listeners should be activated here rather than in the VarEditor.createEditorComponent() method, in order to allow the target containers to optimize the scheduling and load of events to fire, and to ensure proper garbage collection when the interface is destroyed.

Specified by:

activateListeners in class VarEditor<java.lang.Object>

deactivateListeners

protected void deactivateListeners()

Description copied from class: VarEditor

Deactivates listeners on the editor component. Listeners should be deactivated here rather than in the VarEditor.createEditorComponent() method, in order to allow the target containers to optimize the scheduling and load of events to fire, and to ensure proper garbage collection when the interface is destroyed.

Specified by:

deactivateListeners in class VarEditor<java.lang.Object>

isComponentResizeable

public boolean isComponentResizeable()

Overrides:

isComponentResizeable in class VarEditor<java.lang.Object>

Returns:

true if the container panel should allow this component to be resized, false otherwise

getComponentVerticalResizeFactor

public double getComponentVerticalResizeFactor()

Description copied from class: VarEditor

Indicates whether and how this component should resize vertically if the container panel allows resizing. If multiple components in the same panel support resizing, the amount of extra space available will be shared between all components depending on the returned weight (from 0 for no resizing to 1 for maximum resizing).
By default, this value is 0.0 (no vertical resizing)

Overrides:

getComponentVerticalResizeFactor in class VarEditor<java.lang.Object>

Returns:

a value from 0 (no resize allowed) to 1 (resize as much as possible)

setEnabled

public void setEnabled(boolean enabled)

Description copied from class: VarEditor

Enables (or disables) the graphical component associated with the Variable object. This method should be used by the enclosing graphical interface instead of the traditional JComponent.setEnabled(boolean), since listeners are automatically activated (or deactivated) to avoid excessive event firing and ensure proper garbage collection.

Overrides:

setEnabled in class VarEditor<java.lang.Object>

setEditorEnabled

protected void setEditorEnabled(boolean enabled)

Overrides:

setEditorEnabled in class SwingVarEditor<java.lang.Object>

updateInterfaceValue

protected void updateInterfaceValue()

Description copied from class: VarEditor

Updates the graphical interface component to reflect the new value of the underlying variable (accessible via the Var.getValue() method).

Specified by:

updateInterfaceValue in class VarEditor<java.lang.Object>