## org.das2.dasml.OptionListEditor

## OptionListEditor( )

Creates a new instance of FormChoiceEditor

## addCellEditorListener

addCellEditorListener( javax.swing.event.CellEditorListener l ) → void

Adds a listener to the list that's notified when the editor stops, or cancels editing.

### Parameters

l - the CellEditorListener

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## cancelCellEditing

cancelCellEditing( ) → void

Tells the editor to cancel editing and not accept any partially edited value.

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getAsText

getAsText( ) → String

Gets the property value as text.

### Returns:

The property value as a human editable string.

Returns null if the value can't be expressed as an editable string.

If a non-null value is returned, then the PropertyEditor should be prepared to parse that string back in setAsText().
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getCellEditorValue

getCellEditorValue( ) → Object

Returns the value contained in the editor.

### Returns:

the value contained in the editor
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getCustomEditor

getCustomEditor( ) → java.awt.Component

A PropertyEditor may choose to make available a full custom Component that edits its property value. It is the responsibility of the PropertyEditor to hook itself up to its editor Component itself and to report property value changes by firing a PropertyChange event.

The higher-level code that calls getCustomEditor may either embed the Component in some larger property sheet, or it may put it in its own individual dialog, or ...

### Returns:

A java.awt.Component that will allow a human to directly edit the current property value. May be null if this is not supported.
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getJavaInitializationString

getJavaInitializationString( ) → String

This method is intended for use when generating Java code to set the value of the property. It should return a fragment of Java code that can be used to initialize a variable with the current property value.

Example results are "2", "new Color(127,127,34)", "Color.orange", etc.

### Returns:

A fragment of Java code representing an initializer for the current value.
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getOptions

getOptions( ) → org.das2.dasml.ListOption[]

### Returns:

org.das2.dasml.ListOption[]
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getTableCellEditorComponent

getTableCellEditorComponent( javax.swing.JTable table, Object value, boolean isSelected, int row, int column ) → java.awt.Component

Sets an initial `value` for the editor. This will cause the editor to `stopEditing` and lose any partially edited value if the editor is editing when this method is called.

Returns the component that should be added to the client's `Component` hierarchy. Once installed in the client's hierarchy this component will then be able to draw and receive user input.

### Parameters

table - the `JTable` that is asking the editor to edit; can be `null`
value - the value of the cell to be edited; it is up to the specific editor to interpret and draw the value. For example, if value is the string "true", it could be rendered as a string or it could be rendered as a check box that is checked. `null` is a valid value
isSelected - true if the cell is to be rendered with highlighting
row - the row of the cell being edited
column - the column of the cell being edited

### Returns:

the component for editing
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getTags

getTags( ) → String[]

If the property value must be one of a set of known tagged values, then this method should return an array of the tags. This can be used to represent (for example) enum values. If a PropertyEditor supports tags, then it should support the use of setAsText with a tag value as a way of setting the value and the use of getAsText to identify the current value.

### Returns:

The tag values for this property. May be null if this property cannot be represented as a tagged value.
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## getValue

getValue( ) → Object

Gets the property value.

### Returns:

The value of the property. Primitive types such as "int" will be wrapped as the corresponding object type such as "java.lang.Integer".
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## isCellEditable

isCellEditable( java.util.EventObject anEvent ) → boolean

Asks the editor if it can start editing using `anEvent`. `anEvent` is in the invoking component coordinate system. The editor can not assume the Component returned by `getCellEditorComponent` is installed. This method is intended for the use of client to avoid the cost of setting up and installing the editor component if editing is not possible. If editing can be started this method returns true.

### Parameters

anEvent - the event the editor should use to consider whether to begin editing or not

### Returns:

true if editing can be started

### See Also:

shouldSelectCell
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## isPaintable

isPaintable( ) → boolean

Determines whether this property editor is paintable.

### Returns:

True if the class will honor the paintValue method.
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## main

main( String[] args ) → void

### Parameters

args - a java.lang.String[]

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## paintValue

paintValue( java.awt.Graphics gfx, java.awt.Rectangle box ) → void

Paint a representation of the value into a given area of screen real estate. Note that the propertyEditor is responsible for doing its own clipping so that it fits into the given rectangle.

If the PropertyEditor doesn't honor paint requests (see isPaintable) this method should be a silent noop.

The given Graphics object will have the default font, color, etc of the parent container. The PropertyEditor may change graphics attributes such as font and color and doesn't need to restore the old values.

### Parameters

gfx - Graphics object to paint into.
box - Rectangle within graphics object into which we should paint.

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## removeCellEditorListener

removeCellEditorListener( javax.swing.event.CellEditorListener l ) → void

Removes a listener from the list that's notified

### Parameters

l - the CellEditorListener

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## setAsText

setAsText( String text ) → void

Set the property value by parsing a given String. May raise java.lang.IllegalArgumentException if either the String is badly formatted or if this kind of property can't be expressed as text.

### Parameters

text - The string to be parsed.

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## setOptions

setOptions( org.das2.dasml.ListOption[] options ) → void

### Parameters

options - an org.das2.dasml.ListOption[]

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## setValue

setValue( Object value ) → void

Set (or change) the object that is to be edited. Primitive types such as "int" must be wrapped as the corresponding object type such as "java.lang.Integer".

### Parameters

value - The new target object to be edited. Note that this object should not be modified by the PropertyEditor, rather the PropertyEditor should create a new object to hold any modified value.

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## shouldSelectCell

shouldSelectCell( java.util.EventObject anEvent ) → boolean

Returns true if the editing cell should be selected, false otherwise. Typically, the return value is true, because is most cases the editing cell should be selected. However, it is useful to return false to keep the selection from changing for some types of edits. eg. A table that contains a column of check boxes, the user might want to be able to change those checkboxes without altering the selection. (See Netscape Communicator for just such an example) Of course, it is up to the client of the editor to use the return value, but it doesn't need to if it doesn't want to.

### Parameters

anEvent - the event the editor should use to start editing

### Returns:

true if the editor would like the editing cell to be selected; otherwise returns false

### See Also:

isCellEditable
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## showDialog

showDialog( ) → void

### Returns:

void (returns nothing)
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## stopCellEditing

stopCellEditing( ) → boolean

Tells the editor to stop editing and accept any partially edited value as the value of the editor. The editor returns false if editing was not stopped; this is useful for editors that validate and can not accept invalid entries.

### Returns:

true if editing was stopped; false otherwise
[search for examples] [view on GitHub] [view on old javadoc] [view source]

## supportsCustomEditor

supportsCustomEditor( ) → boolean

Determines whether this property editor supports a custom editor.

### Returns:

True if the propertyEditor can provide a custom editor.
[search for examples] [view on GitHub] [view on old javadoc] [view source]