fr.esrf.tangoatk.widget.util.jdraw
Interface JDrawable

All Known Implementing Classes:

BooleanScalarCheckBoxViewer, ConfirmCommandViewer, NumberImageJViewer, NumberImageViewer, NumberScalarCheckBoxViewer, NumberScalarComboEditor, NumberScalarWheelEditor, NumberSpectrumViewer, SignalScalarCheckBoxViewer, SimpleScalarViewer, StringScalarComboEditor, VoidVoidCommandViewer

public interface JDrawable

An interface that must be implemented by a JComponent which can be edited with JDrawEditor.

See Also:

JDrawableList.addClass(java.lang.String)

Method Summary

javax.swing.JComponent	getComponent() Returns the JComponent that implements this interface.
java.lang.String	getDescription(java.lang.String extName) Get a description of this extensions.
java.lang.String	getExtendedParam(java.lang.String name) Returns the specified parameter value.
java.lang.String[]	getExtensionList() Returns list of extension name for this objects (Empty array for none).
void	initForEditing() Call after a component of a JDSwingObject is created, this give a default look and feel for editing.
boolean	setExtendedParam(java.lang.String name, java.lang.String value, boolean popupAllowed) Sets the specified param.

Method Detail

initForEditing

void initForEditing()

Call after a component of a JDSwingObject is created, this give a default look and feel for editing.

getComponent

javax.swing.JComponent getComponent()

Returns the JComponent that implements this interface.

getExtensionList

java.lang.String[] getExtensionList()

Returns list of extension name for this objects (Empty array for none).

setExtendedParam

boolean setExtendedParam(java.lang.String name,
                         java.lang.String value,
                         boolean popupAllowed)

Sets the specified param.

Parameters:

name - Parameter name (Case unsensitive).

value - Parameter value.

popupAllowed - true when the JDrawable should display a popup if the parameter value is incorrect, false otherwise. Note that the JDrawable must not display an error message if the parameter does not exists even if popupAllowed is true.

Returns:

true if parameters has been succesfully applied, false otherwise.

getExtendedParam

java.lang.String getExtendedParam(java.lang.String name)

Returns the specified parameter value.

Parameters:

name - Param name (Case unsensitive).

Returns:

Empty string if not exists, the value otherwise.

getDescription

java.lang.String getDescription(java.lang.String extName)

Get a description of this extensions.

Parameters:

extName - Extension name

Returns:

Empty string for no description.