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

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

All Implemented Interfaces:

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

public class JVxCheckBoxCellEditor
extends JVxStyledCellEditor
implements ICheckBoxCellEditor<Component>

The JVxCheckBoxCellEditor provides the generation of the physical check box 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_DEFAULT, ALIGN_LEFT, ALIGN_RIGHT, ALIGN_STRETCH, ALIGN_TOP

Constructor Summary

JVxCheckBoxCellEditor()
Constructs a new JVxCheckBoxCellEditor.

JVxCheckBoxCellEditor(Object pSelectedValue, Object pDeselectedValue)
Constructs a new JVxCheckBoxCellEditor with the given selected and deselected values.

JVxCheckBoxCellEditor(Object pSelectedValue, Object pDeselectedValue, String pText)
Constructs a new JVxCheckBoxCellEditor with the given selected and deselected values.

Method Summary

ICellEditorHandler<JComponent>	createCellEditorHandler(ICellEditorListener pCellEditorListener, IDataRow pDataRow, String pColumnName) creates an ICellEditorHandler library dependent component.
Component	getCellRendererComponent(Component pParentComponent, IDataPage pDataPage, int pRowNumber, IDataRow pDataRow, String pColumnName, boolean pIsSelected, boolean pHasFocus) Configures a IComponent for rendering.
Object	getDeselectedValue() Gets the value for deselected state.
Object	getSelectedValue() Gets the value for selected state.
String	getText() Gets the text of the checkbox button.
boolean	isDirectCellEditor() Defines, if the editor should edit directly in complex controls.
void	setDeselectedValue(Object pDeselectedValue) Sets the value for deselected state.
void	setSelectedValue(Object pSelectedValue) Sets the value for selected state.
void	setText(String pText) Sets the text of the checkbox button.

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

JVxCheckBoxCellEditor

public JVxCheckBoxCellEditor()

Constructs a new JVxCheckBoxCellEditor.

JVxCheckBoxCellEditor

public JVxCheckBoxCellEditor(Object pSelectedValue,
                             Object pDeselectedValue)

Constructs a new JVxCheckBoxCellEditor with the given selected and deselected values.

Parameters:

pSelectedValue - the selected value.

pDeselectedValue - the deselected value.

JVxCheckBoxCellEditor

public JVxCheckBoxCellEditor(Object pSelectedValue,
                             Object pDeselectedValue,
                             String pText)

Constructs a new JVxCheckBoxCellEditor with the given selected and deselected values.

Parameters:

pSelectedValue - the selected value.

pDeselectedValue - the deselected value.

pText - the text.

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.

getSelectedValue

public Object getSelectedValue()

Gets the value for selected state.

Specified by:

getSelectedValue in interface ICheckBoxCellEditor<Component>

Returns:

all allowed values.

setSelectedValue

public void setSelectedValue(Object pSelectedValue)

Sets the value for selected state.

Specified by:

setSelectedValue in interface ICheckBoxCellEditor<Component>

Parameters:

pSelectedValue - the value for selected state.

getDeselectedValue

public Object getDeselectedValue()

Gets the value for deselected state.

Specified by:

getDeselectedValue in interface ICheckBoxCellEditor<Component>

Returns:

the value for deselected state.

setDeselectedValue

public void setDeselectedValue(Object pDeselectedValue)

Sets the value for deselected state.

Specified by:

setDeselectedValue in interface ICheckBoxCellEditor<Component>

Parameters:

pDeselectedValue - the value for deselected state.

getText

public String getText()

Gets the text of the checkbox button. If no text is set, the column label is used.

Specified by:

getText in interface ICheckBoxCellEditor<Component>

Returns:

the text of the checkbox button.

setText

public void setText(String pText)

Sets the text of the checkbox button. If no text is set, the column label is used.

Specified by:

setText in interface ICheckBoxCellEditor<Component>

Parameters:

pText - the text of the checkbox button.