com.sibvisions.rad.ui.swing.ext.celleditor
Class JVxChoiceCellEditor

java.lang.Object
  com.sibvisions.rad.ui.swing.ext.celleditor.JVxStyledCellEditor
      com.sibvisions.rad.ui.swing.ext.celleditor.JVxChoiceCellEditor

All Implemented Interfaces:

ICellEditor, ICellRenderer<Component>, IChoiceCellEditor<Component>, IStyledCellEditor, IAlignmentConstants

public class JVxChoiceCellEditor
extends JVxStyledCellEditor
implements IChoiceCellEditor<Component>

The JVxChoiceCellEditor provides the generation of the physical choice editor component, handles correct all events, and gives standard access to edited values.

Field Summary

Fields inherited from interface javax.rad.ui.IAlignmentConstants

ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_LEFT, ALIGN_RIGHT, ALIGN_STRETCH, ALIGN_TOP

Constructor Summary

JVxChoiceCellEditor()
Constructs a new JVxChoiceCellEditor.

JVxChoiceCellEditor(Object[] pAllowedValues, String[] pImageNames)
Constructs a new JVxChoiceCellEditor with the given allowed values and image names.

Method Summary

ICellEditorHandler<JComponent>	createCellEditorHandler(ICellEditorListener pCellEditorListener, IDataRow pDataRow, String pColumnName) creates an ICellEditorHandler library dependent component.
Object[]	getAllowedValues() Gets all allowed values.
Component	getCellRendererComponent(Component pParentComponent, IDataPage pDataPage, int pRowNumber, IDataRow pDataRow, String pColumnName, boolean pIsSelected, boolean pHasFocus) Configures a IComponent for rendering.
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.
boolean	isDirectCellEditor() Defines, if the editor should edit directly in complex controls.
void	setAllowedValues(Object[] pAllowedValues) Sets all allowed values.
void	setDefaultImageName(String pDefaultImageName) 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 com.sibvisions.rad.ui.swing.ext.celleditor.JVxStyledCellEditor

getHorizontalAlignment, getVerticalAlignment, 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.ui.IAlignmentConstants

getHorizontalAlignment, getVerticalAlignment, setHorizontalAlignment, setVerticalAlignment

Constructor Detail

JVxChoiceCellEditor

public JVxChoiceCellEditor()

Constructs a new JVxChoiceCellEditor.

JVxChoiceCellEditor

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

Constructs a new JVxChoiceCellEditor with the given allowed values and image names.

Parameters:

pAllowedValues - the allowed values.

pImageNames - the image names.

Method Detail

createCellEditorHandler

public ICellEditorHandler<JComponent> createCellEditorHandler(ICellEditorListener pCellEditorListener,
                                                              IDataRow pDataRow,
                                                              String pColumnName)

creates an ICellEditorHandler library dependent component.

Specified by:

createCellEditorHandler in interface ICellEditor

Parameters:

pCellEditorListener - the ICellEditorListener

pDataRow - the IDataRow

pColumnName - the column name

Returns:

the ICellEditorHandler.

getCellRendererComponent

public Component getCellRendererComponent(Component 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<Component>

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.

isDirectCellEditor

public boolean isDirectCellEditor()

Defines, if the editor should edit directly in complex controls.

Specified by:

isDirectCellEditor in interface ICellEditor

Returns:

the ICellEditorHandler.

getAllowedValues

public Object[] getAllowedValues()

Gets all allowed values.

Specified by:

getAllowedValues in interface IChoiceCellEditor<Component>

Returns:

all allowed values.

setAllowedValues

public void setAllowedValues(Object[] pAllowedValues)

Sets all allowed values.

Specified by:

setAllowedValues in interface IChoiceCellEditor<Component>

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<Component>

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<Component>

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<Component>

Returns:

the default image.

setDefaultImageName

public void setDefaultImageName(String pDefaultImageName)

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

Specified by:

setDefaultImageName in interface IChoiceCellEditor<Component>

Parameters:

pDefaultImageName - the default image name.