javax.rad.genui.celleditor
Class UIChoiceCellEditor

java.lang.Object
  javax.rad.genui.celleditor.UICellEditor<IChoiceCellEditor>
      javax.rad.genui.celleditor.UIChoiceCellEditor

All Implemented Interfaces:

ICellEditor, ICellRenderer, IChoiceCellEditor, IStyledCellEditor, IAlignmentConstants, IResource

public class UIChoiceCellEditor
extends UICellEditor<IChoiceCellEditor>
implements IChoiceCellEditor

Platform and technology independent choice editor. It is designed for use with AWT, Swing, SWT, JSP, JSF, ... .

Field Summary

Fields inherited from interface javax.rad.ui.IAlignmentConstants

ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_LEFT, ALIGN_RIGHT, ALIGN_STRETCH, ALIGN_TOP

Constructor Summary

	UIChoiceCellEditor() Creates a new instance of UIChoiceCellEditor.
protected	UIChoiceCellEditor(IChoiceCellEditor pEditor) Creates a new instance of UIChoiceCellEditor with the given choice cell editor.
	UIChoiceCellEditor(Object[] pAllowedValues, String[] pImageNames) Creates a new instance of UIChoiceCellEditor with the given allowed values and image names.
	UIChoiceCellEditor(Object[] pAllowedValues, String[] pImageNames, String pDefaultImage) Creates a new instance of UIChoiceCellEditor with the given allowed values and image names.

Method Summary

static boolean	addDefaultChoiceCellEditor(IChoiceCellEditor pEditor) Adds a choice cell editor to the list of default choice cell editors.
Object[]	getAllowedValues() Gets all allowed values.
Object	getCellRendererComponent(Object pParentComponent, IDataPage pDataPage, int pRowNumber, IDataRow pDataRow, String pColumnName, boolean pIsSelected, boolean pHasFocus) Configures a IComponent for rendering.
static IChoiceCellEditor	getDefaultChoiceCellEditor(Object[] pValues) Gets a choice cell editor from the defaults list, if an editor is available for specific values.
static IChoiceCellEditor[]	getDefaultChoiceCellEditors() Gets all currently available default choice cell editors as array.
String	getDefaultImageName() Gets the default image that is shown if selectedIndex is -1.
String[]	getImageNames() Gets the image names that are used for displaying the corresponding values.
static void	removeAllDefaultChoiceCellEditors() Removes all default choice cell editors.
static void	removeDefaultChoiceCellEditor(IChoiceCellEditor pEditor) Removes a choice cell editor from the list of default choice cell editors.
void	setAllowedValues(Object[] pAllowedValues) Sets all allowed values.
void	setDefaultImageName(String pDefaultImage) Sets the default image name that is shown if selectedIndex is -1.
void	setImageNames(String[] pImageNames) Sets the image names that are used for displaying the corresponding values.

Methods inherited from class javax.rad.genui.celleditor.UICellEditor

createCellEditorHandler, getDefaultCellEditor, getHorizontalAlignment, getResource, getVerticalAlignment, isDirectCellEditor, setDefaultCellEditor, setHorizontalAlignment, setVerticalAlignment

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.rad.model.ui.ICellEditor

createCellEditorHandler, isDirectCellEditor

Methods inherited from interface javax.rad.ui.IAlignmentConstants

getHorizontalAlignment, getVerticalAlignment, setHorizontalAlignment, setVerticalAlignment

Constructor Detail

UIChoiceCellEditor

public UIChoiceCellEditor()

Creates a new instance of UIChoiceCellEditor.

See Also:

IChoiceCellEditor

UIChoiceCellEditor

protected UIChoiceCellEditor(IChoiceCellEditor pEditor)

Creates a new instance of UIChoiceCellEditor with the given choice cell editor.

Parameters:

pEditor - the choice cell editor

See Also:

IChoiceCellEditor

UIChoiceCellEditor

public UIChoiceCellEditor(Object[] pAllowedValues,
                          String[] pImageNames)

Creates a new instance of UIChoiceCellEditor with the given allowed values and image names.

Parameters:

pAllowedValues - the allowed values.

pImageNames - the image names.

See Also:

IChoiceCellEditor

UIChoiceCellEditor

public UIChoiceCellEditor(Object[] pAllowedValues,
                          String[] pImageNames,
                          String pDefaultImage)

Creates a new instance of UIChoiceCellEditor with the given allowed values and image names.

Parameters:

pAllowedValues - the allowed values.

pImageNames - the image names.

pDefaultImage - the default image name.

See Also:

IChoiceCellEditor

Method Detail

getAllowedValues

public Object[] getAllowedValues()

Gets all allowed values.

Specified by:

getAllowedValues in interface IChoiceCellEditor

Returns:

all allowed values.

setAllowedValues

public void setAllowedValues(Object[] pAllowedValues)

Sets all allowed values.

Specified by:

setAllowedValues in interface IChoiceCellEditor

Parameters:

pAllowedValues - all allowed values.

getImageNames

public String[] getImageNames()

Gets the image names that are used for displaying the corresponding values.

Specified by:

getImageNames in interface IChoiceCellEditor

Returns:

the image names.

setImageNames

public void setImageNames(String[] pImageNames)

Sets the image names that are used for displaying the corresponding values.

Specified by:

setImageNames in interface IChoiceCellEditor

Parameters:

pImageNames - the image names.

getDefaultImageName

public String getDefaultImageName()

Gets the default image that is shown if selectedIndex is -1.

Specified by:

getDefaultImageName in interface IChoiceCellEditor

Returns:

the default image.

setDefaultImageName

public void setDefaultImageName(String pDefaultImage)

Sets the default image name that is shown if selectedIndex is -1.

Specified by:

setDefaultImageName in interface IChoiceCellEditor

Parameters:

pDefaultImage - the default image name.

getCellRendererComponent

public Object getCellRendererComponent(Object pParentComponent,
                                       IDataPage pDataPage,
                                       int pRowNumber,
                                       IDataRow pDataRow,
                                       String pColumnName,
                                       boolean pIsSelected,
                                       boolean pHasFocus)

Configures a IComponent for rendering. The IComponent can be reused for performance reasons. After a new call of getCellRendererComponent, the previous IComponent can't be used for rendering anymore.

Specified by:

getCellRendererComponent in interface ICellRenderer

Parameters:

pParentComponent - the Parent Component from which.

pDataPage - the DataPage of the row to be rendered.

pRowNumber - the row number of the row to be rendered.

pDataRow - the row to be rendered (is the same as pDataPage.getRow(pRowNumber)).

pColumnName - the column name to be rendered.

pIsSelected - true, if the cell is selected (shown with selected background).

pHasFocus - true, if the cell has the focus (cell is the current editing cell).

Returns:

the renderer Component. It can only be used until the next call of this function.

getDefaultChoiceCellEditor

public static IChoiceCellEditor getDefaultChoiceCellEditor(Object[] pValues)

Gets a choice cell editor from the defaults list, if an editor is available for specific values.

Parameters:

pValues - a list of values for which a choice cell editor should be found. All values must match to the allowed values of a registered editor.

Returns:

a choice cell editor for pValue or null if no matching editor was found.

getDefaultChoiceCellEditors

public static IChoiceCellEditor[] getDefaultChoiceCellEditors()

Gets all currently available default choice cell editors as array.

Returns:

an array with default choice cell editors always != null

addDefaultChoiceCellEditor

public static boolean addDefaultChoiceCellEditor(IChoiceCellEditor pEditor)

Adds a choice cell editor to the list of default choice cell editors. The allowed values of the cell editor will be used to check if there is already a choice cell editor present.

Parameters:

pEditor - the choice cell editor

Returns:

true if the editor was added, false if an editor with the same allowed values was already added

removeDefaultChoiceCellEditor

public static void removeDefaultChoiceCellEditor(IChoiceCellEditor pEditor)

Removes a choice cell editor from the list of default choice cell editors.

Parameters:

pEditor - the choice cell editor

removeAllDefaultChoiceCellEditors

public static void removeAllDefaultChoiceCellEditors()

Removes all default choice cell editors.