javax.rad.genui.celleditor
Class UILinkedCellEditor

java.lang.Object
  javax.rad.genui.AbstractUIFactoryResource<CE>
      javax.rad.genui.celleditor.UICellEditor<CE>
          javax.rad.genui.celleditor.UIInplaceCellEditor<CE>
              javax.rad.genui.celleditor.UIComboCellEditor<ILinkedCellEditor>
                  javax.rad.genui.celleditor.UILinkedCellEditor

All Implemented Interfaces:

ICellEditor, IComboCellEditor, IInplaceCellEditor, ILinkedCellEditor, IStyledCellEditor, IAlignmentConstants, IResource

public class UILinkedCellEditor
extends UIComboCellEditor<ILinkedCellEditor>
implements ILinkedCellEditor

Platform and technology independent linked editor. 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

Constructor Summary

	UILinkedCellEditor() Creates a new instance of UILinkedCellEditor.
protected	UILinkedCellEditor(ILinkedCellEditor pEditor) Creates a new instance of UILinkedCellEditor with the given linked cell editor.
	UILinkedCellEditor(ReferenceDefinition pReferenceDefinition) Creates a new instance of UILinkedCellEditor with LinkReference.

Method Summary

ICondition	getAdditionalCondition() Gets the additional condition, that is combined with And.
ColumnView	getColumnView() Returns the ColumnView displayed by this control.
java.lang.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	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	setColumnView(ColumnView pColumnView) Sets the ColumnView displayed by this control.
void	setDisplayReferencedColumnName(java.lang.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	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 javax.rad.genui.celleditor.UIComboCellEditor

isAutoOpenPopup, setAutoOpenPopup

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

getPreferredEditorMode, setPreferredEditorMode

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

addDefaultCellEditor, createCacheKey, createCellEditorHandler, getDefaultCellEditor, getDefaultCellEditor, getDefaultCellEditors, getDefaultCellEditors, getHorizontalAlignment, getResource, getVerticalAlignment, isDirectCellEditor, removeAllDefaultCellEditors, removeAllDefaultCellEditors, removeDefaultCellEditor, setDefaultCellEditor, setHorizontalAlignment, setVerticalAlignment

Methods inherited from class javax.rad.genui.AbstractUIFactoryResource

getUIResource, setUIResource

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.model.ui.ICellEditor

createCellEditorHandler, isDirectCellEditor

Methods inherited from interface javax.rad.ui.IAlignmentConstants

getHorizontalAlignment, getVerticalAlignment, setHorizontalAlignment, setVerticalAlignment

Constructor Detail

UILinkedCellEditor

public UILinkedCellEditor()

Creates a new instance of UILinkedCellEditor.

See Also:

ILinkedCellEditor

UILinkedCellEditor

protected UILinkedCellEditor(ILinkedCellEditor pEditor)

Creates a new instance of UILinkedCellEditor with the given linked cell editor.

Parameters:

pEditor - the linked cell editor

See Also:

ILinkedCellEditor

UILinkedCellEditor

public UILinkedCellEditor(ReferenceDefinition pReferenceDefinition)

Creates a new instance of UILinkedCellEditor with LinkReference.

Parameters:

pReferenceDefinition - the LinkReference.

See Also:

ILinkedCellEditor

Method Detail

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

Sets reference definition that defines the link.

Specified by:

setLinkReference in interface ILinkedCellEditor

Parameters:

pReferenceDefinition - 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 pSearchColumnNames)

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

Specified by:

setSearchColumnMapping in interface ILinkedCellEditor

Parameters:

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

getColumnView

public ColumnView getColumnView()

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

Specified by:

getColumnView in interface ILinkedCellEditor

Returns:

the ColumnView.

See Also:

ILinkedCellEditor.setColumnView(javax.rad.model.ColumnView)

setColumnView

public void setColumnView(ColumnView pColumnView)

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

Specified by:

setColumnView in interface ILinkedCellEditor

Parameters:

pColumnView - the ColumnView

See Also:

ILinkedCellEditor.getColumnView()

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.

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.

getDisplayReferencedColumnName

public java.lang.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.

Specified by:

getDisplayReferencedColumnName in interface ILinkedCellEditor

Returns:

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

setDisplayReferencedColumnName

public void setDisplayReferencedColumnName(java.lang.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.

Specified by:

setDisplayReferencedColumnName in interface ILinkedCellEditor

Parameters:

pDisplayReferencedColumnName - the name of the display referenced column.