javax.rad.ui.celleditor
Interface ILinkedCellEditor

All Superinterfaces:

IAlignmentConstants, ICellEditor, IComboCellEditor, IInplaceCellEditor, IStyledCellEditor

All Known Implementing Classes:

AbstractLinkedCellEditor, JVxLinkedCellEditor, UILinkedCellEditor

public interface ILinkedCellEditor
extends IComboCellEditor

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

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_DEFAULT, ALIGN_LEFT, ALIGN_RIGHT, ALIGN_STRETCH, ALIGN_TOP

Method Summary

ICondition	getAdditionalCondition() Gets the additional condition, that is combined with And.
ColumnView	getColumnView() Returns the ColumnView displayed by this control.
String	getDisplayConcatMask() Gets the concat mask that is used for displaying values.
String	getDisplayReferencedColumnName() Gets the name of the referenced column that is used for displaying values.
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	isSearchInAllTableColumns() True, if the text is searched in all visible table columns.
boolean	isSearchTextAnywhere() True, if the text is searched anywhere inside a column.
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	setColumnView(ColumnView pColumnView) Sets the ColumnView displayed by this control.
void	setDisplayConcatMask(String pDisplayConcatMasks) Gets the concat mask that is used for displaying values.
void	setDisplayReferencedColumnName(String pDisplayReferencedColumnName) Sets the name of the referenced column that is used for displaying values.
void	setLinkReference(ReferenceDefinition pReferenceDefinition) 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 pSearchColumnNames) Sets search columns for which should be searched in the linked cell.
void	setSearchInAllTableColumns(boolean pSearchInAllTableColumns) True, if the text is searched in all visible table columns.
void	setSearchTextAnywhere(boolean pSearchTextAnywhere) True, if the text is searched anywhere inside a column.
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 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.model.ui.ICellEditor

createCellEditorHandler, isDirectCellEditor

Methods inherited from interface javax.rad.ui.IAlignmentConstants

getHorizontalAlignment, getVerticalAlignment, setHorizontalAlignment, setVerticalAlignment

Method Detail

getLinkReference

ReferenceDefinition getLinkReference()

Gets reference definition that defines the link.

Returns:

the link reference definition.

setLinkReference

void setLinkReference(ReferenceDefinition pReferenceDefinition)

Sets reference definition that defines the link.

Parameters:

pReferenceDefinition - the link reference definition.

getAdditionalCondition

ICondition getAdditionalCondition()

Gets the additional condition, that is combined with And.

Returns:

the additional condition.

setAdditionalCondition

void setAdditionalCondition(ICondition pCondition)

Sets the additional condition, that is combined with And.

Parameters:

pCondition - the additional condition.

getSearchColumnMapping

ColumnMapping getSearchColumnMapping()

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

Returns:

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

setSearchColumnMapping

void setSearchColumnMapping(ColumnMapping pSearchColumnNames)

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

Parameters:

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

isSortByColumnName

boolean isSortByColumnName()

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

Returns:

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

setSortByColumnName

void setSortByColumnName(boolean pSortByColumnName)

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

Parameters:

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

isTableReadonly

boolean isTableReadonly()

Gets whether the table in the popup readonly.

Returns:

the table in the popup readonly.

setTableReadonly

void setTableReadonly(boolean pTableReadonly)

Sets the table in the popup readonly.

Parameters:

pTableReadonly - sets the table in the popup readonly.

isTableHeaderVisible

boolean isTableHeaderVisible()

Gets whether the table header is visible.

Returns:

whether the table header is visible.

setTableHeaderVisible

void setTableHeaderVisible(boolean pTableHeaderVisible)

Sets the table header visible.

Parameters:

pTableHeaderVisible - the table header visible.

isValidationEnabled

boolean isValidationEnabled()

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

Returns:

true, if only values from the table are allowed.

setValidationEnabled

void setValidationEnabled(boolean pValidationEnabled)

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

Parameters:

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

isSearchTextAnywhere

boolean isSearchTextAnywhere()

True, if the text is searched anywhere inside a column. Default is true.

Returns:

True, if the text is searched anywhere inside a column.

setSearchTextAnywhere

void setSearchTextAnywhere(boolean pSearchTextAnywhere)

True, if the text is searched anywhere inside a column. Default is true.

Parameters:

pSearchTextAnywhere - True, if the text is searched anywhere inside a column.

isSearchInAllTableColumns

boolean isSearchInAllTableColumns()

True, if the text is searched in all visible table columns. Default is false.

Returns:

True, if the text is searched in all visible table columns.

setSearchInAllTableColumns

void setSearchInAllTableColumns(boolean pSearchInAllTableColumns)

True, if the text is searched in all visible table columns. Default is false.

Parameters:

pSearchInAllTableColumns - True, if the text is searched in all visible table columns.

getColumnView

ColumnView getColumnView()

Returns the ColumnView displayed by this control. If null is set, the default ColumnView is shown.

Returns:

the ColumnView.

See Also:

setColumnView(javax.rad.model.ColumnView)

setColumnView

void setColumnView(ColumnView pColumnView)

Sets the ColumnView displayed by this control. If null is set, the default ColumnView is shown.

Parameters:

pColumnView - the ColumnView

See Also:

getColumnView()

getPopupSize

IDimension getPopupSize()

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

Returns:

the Popup size of.

setPopupSize

void setPopupSize(IDimension pPopupSize)

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

Parameters:

pPopupSize - the Popup size of.

getDisplayReferencedColumnName

String getDisplayReferencedColumnName()

Gets the name of the referenced column that is used for displaying values. These values will be displayed instead of the default-shown values. Will return null if no display referenced column name is set and the editors default behavior decides what is displayed.

Returns:

the name of the display referenced column. null if not set.

setDisplayReferencedColumnName

void setDisplayReferencedColumnName(String pDisplayReferencedColumnName)

Sets the name of the referenced column that is used for displaying values. These values will be displayed instead of the default-shown values.

Parameters:

pDisplayReferencedColumnName - the name of the display referenced column.

getDisplayConcatMask

String getDisplayConcatMask()

Gets the concat mask that is used for displaying values. All visible columns shown in the popup will be concatinated with the given mask. e.g. " “, " - “, ... will lead in “AT 1220 Vienna”, “AT - 1220 - Vienna”

Returns:

the concat mask that is used for displaying values. null if not set.

setDisplayConcatMask

void setDisplayConcatMask(String pDisplayConcatMasks)

Gets the concat mask that is used for displaying values. All visible columns shown in the popup will be concatinated with the given mask. e.g. " “, " - “, ... will lead in “AT 1220 Vienna”, “AT - 1220 - Vienna”

Parameters:

pDisplayConcatMasks - the concat mask that is used for displaying values. null if not set.