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

java.lang.Object
  com.sibvisions.rad.ui.swing.ext.celleditor.JVxStyledCellEditor
      com.sibvisions.rad.ui.swing.ext.celleditor.JVxInplaceCellEditor
          com.sibvisions.rad.ui.swing.ext.celleditor.JVxComboCellEditor
              com.sibvisions.rad.ui.swing.ext.celleditor.JVxLinkedCellEditor

All Implemented Interfaces:

ICellEditor, ICellRenderer<JComponent>, IComboCellEditor, IInplaceCellEditor, ILinkedCellEditor, IStyledCellEditor, IAlignmentConstants

public class JVxLinkedCellEditor
extends JVxComboCellEditor
implements ILinkedCellEditor, ICellRenderer<JComponent>

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

Nested Class Summary

static class

JVxLinkedCellEditor.CellEditorHandler Sets the internal changed Flag, and informs the CellEditorListener if editing is completed.

Field Summary

Fields inherited from interface javax.rad.ui.celleditor.IInplaceCellEditor

DOUBLE_CLICK, SINGLE_CLICK

Fields inherited from interface javax.rad.ui.IAlignmentConstants

ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_LEFT, ALIGN_RIGHT, ALIGN_STRETCH, ALIGN_TOP

Constructor Summary

JVxLinkedCellEditor()
Constructs a new JVxLinkedCellEditor.

JVxLinkedCellEditor(ReferenceDefinition pLinkReference)
Constructs a new JVxLinkedCellEditor with the given link reference.

Method Summary

ICellEditorHandler<JComponent>	createCellEditorHandler(ICellEditorListener pCellEditorListener, IDataRow pDataRow, String pColumnName) creates an ICellEditorHandler library dependent component.
ICondition	getAdditionalCondition() Gets the additional condition, that is combined with And.
JComponent	getCellRendererComponent(JComponent pParentComponent, IDataPage pDataPage, int pRowNumber, IDataRow pDataRow, String pColumnName, boolean pIsSelected, boolean hasFocus) Configures a IComponent for rendering.
ReferenceDefinition	getLinkReference() Gets reference definition that defines the link.
IDimension	getPopupSize() Gets the size of the Popup window using a Dimension object.
ColumnMapping	getSearchColumnMapping() Gets search columns for which should be searched in the linked cell.
boolean	isDirectCellEditor() Defines, if the editor should edit directly in complex controls.
boolean	isSearchTextAnywhere() True, if the text is searched anywhere.
boolean	isSortByColumnName() True, if the linked cell editor should sort by the column name it is editing.
boolean	isTableHeaderVisible() Gets whether the table header is visible.
boolean	isTableReadonly() Gets whether the table in the popup readonly.
boolean	isValidationEnabled() Gets true, if only values from the table are allowed.
void	setAdditionalCondition(ICondition pCondition) Sets the additional condition, that is combined with And.
void	setLinkReference(ReferenceDefinition pLinkReference) Sets reference definition that defines the link.
void	setPopupSize(IDimension pPopupSize) Sets the size of the Popup window using a Dimension object.
void	setSearchColumnMapping(ColumnMapping pSearchColumnMapping) Sets search columns for which should be searched in the linked cell.
void	setSearchTextAnywhere(boolean pSearchTextAnywhere) True, if the text is searched anywhere.
void	setSortByColumnName(boolean pSortByColumnName) True, if the linked cell editor should sort by the column name it is editing.
void	setTableHeaderVisible(boolean pTableHeaderVisible) Sets the table header visible.
void	setTableReadonly(boolean pTableReadonly) Sets the table in the popup readonly.
void	setValidationEnabled(boolean pValidationEnabled) Sets true, if only values from the table are allowed.

Methods inherited from class com.sibvisions.rad.ui.swing.ext.celleditor.JVxComboCellEditor

isAutoOpenPopup, setAutoOpenPopup

Methods inherited from class com.sibvisions.rad.ui.swing.ext.celleditor.JVxInplaceCellEditor

getPreferredEditorMode, setPreferredEditorMode

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.celleditor.IComboCellEditor

isAutoOpenPopup, setAutoOpenPopup

Methods inherited from interface javax.rad.ui.celleditor.IInplaceCellEditor

getPreferredEditorMode, setPreferredEditorMode

Methods inherited from interface javax.rad.ui.IAlignmentConstants

getHorizontalAlignment, getVerticalAlignment, setHorizontalAlignment, setVerticalAlignment

Constructor Detail

JVxLinkedCellEditor

public JVxLinkedCellEditor()

Constructs a new JVxLinkedCellEditor.

JVxLinkedCellEditor

public JVxLinkedCellEditor(ReferenceDefinition pLinkReference)

Constructs a new JVxLinkedCellEditor with the given link reference.

Parameters:

pLinkReference - the link reference.

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.

isDirectCellEditor

public boolean isDirectCellEditor()

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

Specified by:

isDirectCellEditor in interface ICellEditor

Returns:

the ICellEditorHandler.

getLinkReference

public ReferenceDefinition getLinkReference()

Gets reference definition that defines the link.

Specified by:

getLinkReference in interface ILinkedCellEditor

Returns:

the link reference definition.

setLinkReference

public void setLinkReference(ReferenceDefinition pLinkReference)

Sets reference definition that defines the link.

Specified by:

setLinkReference in interface ILinkedCellEditor

Parameters:

pLinkReference - the link reference definition.

getAdditionalCondition

public ICondition getAdditionalCondition()

Gets the additional condition, that is combined with And.

Specified by:

getAdditionalCondition in interface ILinkedCellEditor

Returns:

the additional condition.

setAdditionalCondition

public void setAdditionalCondition(ICondition pCondition)

Sets the additional condition, that is combined with And.

Specified by:

setAdditionalCondition in interface ILinkedCellEditor

Parameters:

pCondition - the additional condition.

getSearchColumnMapping

public ColumnMapping getSearchColumnMapping()

Gets search columns for which should be searched in the linked cell.

Specified by:

getSearchColumnMapping in interface ILinkedCellEditor

Returns:

search columns for which should be searched in the linked cell.

setSearchColumnMapping

public void setSearchColumnMapping(ColumnMapping pSearchColumnMapping)

Sets search columns for which should be searched in the linked cell.

Specified by:

setSearchColumnMapping in interface ILinkedCellEditor

Parameters:

pSearchColumnMapping - search columns for which should be searched in the linked cell.

isSortByColumnName

public boolean isSortByColumnName()

True, if the linked cell editor should sort by the column name it is editing. Default is false.

Specified by:

isSortByColumnName in interface ILinkedCellEditor

Returns:

true, if the linked cell editor should sort by the column name it is editing.

setSortByColumnName

public void setSortByColumnName(boolean pSortByColumnName)

True, if the linked cell editor should sort by the column name it is editing. Default is false.

Specified by:

setSortByColumnName in interface ILinkedCellEditor

Parameters:

pSortByColumnName - true, if the linked cell editor should sort by the column name it is editing.

isTableReadonly

public boolean isTableReadonly()

Gets whether the table in the popup readonly.

Specified by:

isTableReadonly in interface ILinkedCellEditor

Returns:

the table in the popup readonly.

setTableReadonly

public void setTableReadonly(boolean pTableReadonly)

Sets the table in the popup readonly.

Specified by:

setTableReadonly in interface ILinkedCellEditor

Parameters:

pTableReadonly - sets the table in the popup readonly.

isTableHeaderVisible

public boolean isTableHeaderVisible()

Gets whether the table header is visible.

Specified by:

isTableHeaderVisible in interface ILinkedCellEditor

Returns:

whether the table header is visible.

setTableHeaderVisible

public void setTableHeaderVisible(boolean pTableHeaderVisible)

Sets the table header visible.

Specified by:

setTableHeaderVisible in interface ILinkedCellEditor

Parameters:

pTableHeaderVisible - the table header visible.

isValidationEnabled

public boolean isValidationEnabled()

Gets true, if only values from the table are allowed.

Specified by:

isValidationEnabled in interface ILinkedCellEditor

Returns:

true, if only values from the table are allowed.

setValidationEnabled

public void setValidationEnabled(boolean pValidationEnabled)

Sets true, if only values from the table are allowed.

Specified by:

setValidationEnabled in interface ILinkedCellEditor

Parameters:

pValidationEnabled - true, if only values from the table are allowed.

isSearchTextAnywhere

public boolean isSearchTextAnywhere()

True, if the text is searched anywhere. Default is true.

Specified by:

isSearchTextAnywhere in interface ILinkedCellEditor

Returns:

True, if the text is searched anywhere.

setSearchTextAnywhere

public void setSearchTextAnywhere(boolean pSearchTextAnywhere)

True, if the text is searched anywhere. Default is true.

Specified by:

setSearchTextAnywhere in interface ILinkedCellEditor

Parameters:

pSearchTextAnywhere - True, if the text is searched anywhere.

getPopupSize

public IDimension getPopupSize()

Gets the size of the Popup window using a Dimension object. Null means, that the Popup window opens with preferredSize.

Specified by:

getPopupSize in interface ILinkedCellEditor

Returns:

the Popup size of.

setPopupSize

public void setPopupSize(IDimension pPopupSize)

Sets the size of the Popup window using a Dimension object. Null means, that the Popup window opens with preferredSize.

Specified by:

setPopupSize in interface ILinkedCellEditor

Parameters:

pPopupSize - the Popup size of.

getCellRendererComponent

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

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

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).

hasFocus - 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.