Search this API

y.option
Interface Editor

All Known Subinterfaces:
CompoundEditor, ItemEditor
All Known Implementing Classes:
AbstractItemEditor, DefaultCompoundEditor

public interface Editor

Specifies the general contract of an option editor. Editors serve as views/controllers for the parameters managed by an OptionHandler.

Editors that want to support PropertyChange and/or VetoableChange events should implement the PropertyChangeReporter and/or the VetoableChangeReporter interfaces.

Note:
OptionHandler and OptionItem store editors using weak references. Editor implementations have to ensure that they do not become eligible for garbage collection while their view components are in use.

 

Nested Class Summary
static class Editor.Event
          An event reported when an editor is added or removed.
static interface Editor.Listener
          Interface to support notification when an editor is added or removed.
 
Method Summary
 void adoptItemValue()
          Resets the editor value(s) to the value(s) currently stored in the corresponding option item(s).
 void commitValue()
          Commits the value(s) that was (were) modified with the editor to the corresponding option item(s).
 javax.swing.JComponent getComponent()
          Returns the editor component for this editor.
 void resetValue()
          Resets the value(s) to its (their) original setting(s).
 

Method Detail

commitValue

void commitValue()
Commits the value(s) that was (were) modified with the editor to the corresponding option item(s).


adoptItemValue

void adoptItemValue()
Resets the editor value(s) to the value(s) currently stored in the corresponding option item(s).


resetValue

void resetValue()
Resets the value(s) to its (their) original setting(s).


getComponent

javax.swing.JComponent getComponent()
Returns the editor component for this editor.


© Copyright 2000-2021,
yWorks GmbH.
All rights reserved.