com.sibvisions.rad.ui.swing.impl.control
Class SwingEditor

java.lang.Object
  com.sibvisions.rad.ui.awt.impl.AwtResource<C>
      com.sibvisions.rad.ui.awt.impl.AwtComponent<C>
          com.sibvisions.rad.ui.awt.impl.AwtContainer<C>
              com.sibvisions.rad.ui.swing.impl.SwingComponent<JVxEditor>
                  com.sibvisions.rad.ui.swing.impl.control.SwingEditor

All Implemented Interfaces:

ICellFormatter, ComponentListener, FocusListener, KeyListener, MouseListener, EventListener, IControl, IEditorControl, ITranslatable, ICellFormatable, IEditor, IAlignmentConstants, IComponent, IContainer, IResource, INamedObject

public class SwingEditor
extends SwingComponent<JVxEditor>
implements IEditor, ICellFormatter

The SwingEditor is the IEditor implementation for swing.

See Also:

JVxEditor

Field Summary

Fields inherited from class com.sibvisions.rad.ui.awt.impl.AwtComponent

bComponentListener, bFocusListener, bKeyListener, bMouseListener, eventComponentMoved, eventComponentResized, eventKeyPressed, eventKeyReleased, eventKeyTyped, eventMouseClicked, eventMouseEntered, eventMouseExited, eventMousePressed, eventMouseReleased, eventSource, factory, parent

Fields inherited from class com.sibvisions.rad.ui.awt.impl.AwtResource

resource

Fields inherited from interface javax.rad.ui.IAlignmentConstants

ALIGN_BOTTOM, ALIGN_CENTER, ALIGN_DEFAULT, ALIGN_LEFT, ALIGN_RIGHT, ALIGN_STRETCH, ALIGN_TOP

Constructor Summary

SwingEditor()
Creates a new instance of SwingEditor.

Method Summary

void	cancelEditing() Informs the GUI control, that the last edit should be canceled(restored) the correct value is in the DataBook.
ICellEditor	getCellEditor() Gets the CellEditor that edits the given column in the given DataRow.
CellFormat	getCellFormat(IDataBook pDataBook, IDataPage pDataPage, IDataRow pDataRow, String pColumnName, int pRow, int pColumn) Gets the format for the given cell.
ICellFormatter	getCellFormatter() Gets the cell formatter.
String	getColumnName() Returns the column name displayed by this control.
IDataRow	getDataRow() Returns the DataRow displayed by this control.
String	getName() Gets the name of the object. Implementing classes need to make sure that no name is set during the creation of the component. A unique name (based on the position of the component in the component tree) will be generated and set when the component is added, but only if the name of the component is null.
TranslationMap	getTranslation() Gets the possible translation mapping.
boolean	isBorderVisible() Returns whether the the border of the text field is visible.
boolean	isSavingImmediate() Tells whether the CellEditor should save immediate.
boolean	isTranslationEnabled() Gets whether the translation is en- or disabled.
void	notifyRepaint() The control need to check if the part is visible and then repaint the part.
void	saveEditing() Informs the GUI control, that the last edit should be set into the IDataBook or IDataRow.
void	setBorderVisible(boolean pVisible) Sets the border of the text field visible or invisible.
void	setCellEditor(ICellEditor pCellEditor) Sets the CellEditor that edits the given column in the given DataRow.
void	setCellFormatter(ICellFormatter pCellFormatter) Sets the cell formatter.
void	setColumnName(String pColumnName) Sets the column name displayed by this control.
void	setDataRow(IDataRow pDataRow) Sets the DataRow displayed by this control.
void	setHorizontalAlignment(int pHorizontalAlignment) Sets the horizontal alignment. Possible values are defined in AlignmentConstants.
void	setName(String pName) Sets the name of the object to the specified string.
void	setSavingImmediate(boolean pSavingImmediate) Sets whether the CellEditor should save immediate.
void	setTranslation(TranslationMap pTranslation) Sets the possible translations.
void	setTranslationEnabled(boolean pEnabled) Sets the translation en- or disabled.
void	setVerticalAlignment(int pVerticalAlignment) Sets the vertical alignment. Possible values are defined in AlignmentConstants.

Methods inherited from class com.sibvisions.rad.ui.swing.impl.SwingComponent

capture, getToolTipText, setBackground, setTabIndex, setToolTipText

Methods inherited from class com.sibvisions.rad.ui.awt.impl.AwtContainer

add, add, add, add, addIntern, checkAdd, getComponent, getComponentCount, getLayout, indexOf, remove, remove, removeAll, removeIntern, setLayout, setLayoutIntern

Methods inherited from class com.sibvisions.rad.ui.awt.impl.AwtComponent

addComponentListener, addFocusListener, addKeyListener, addMouseListener, componentHidden, componentMoved, componentResized, componentShown, createImage, createMouseEvent, eventComponentMoved, eventComponentResized, eventFocusGained, eventFocusLost, eventKeyPressed, eventKeyReleased, eventKeyTyped, eventMouseClicked, eventMouseEntered, eventMouseExited, eventMousePressed, eventMouseReleased, focusGained, focusLost, getBackground, getBounds, getCursor, getEventSource, getFactory, getFont, getForeground, getHorizontalAlignment, getLocation, getLocationRelativeTo, getMaximumSize, getMinimumSize, getParent, getPreferredSize, getSize, getTabIndex, getVerticalAlignment, invalidateLayout, isBackgroundSet, isCursorSet, isEnabled, isFocusable, isFontSet, isForegroundSet, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isVisible, keyPressed, keyReleased, keyTyped, mouseClicked, mouseEntered, mouseExited, mousePressed, mouseReleased, requestFocus, setBounds, setCursor, setEnabled, setEventSource, setFactory, setFocusable, setFont, setForeground, setLocation, setLocationRelativeTo, setMaximumSize, setMinimumSize, setParent, setPreferredSize, setSize, setVisible, validate

Methods inherited from class com.sibvisions.rad.ui.awt.impl.AwtResource

equals, getResource, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.rad.ui.IComponent

capture, eventComponentMoved, eventComponentResized, eventFocusGained, eventFocusLost, eventKeyPressed, eventKeyReleased, eventKeyTyped, eventMouseClicked, eventMouseEntered, eventMouseExited, eventMousePressed, eventMouseReleased, getBackground, getBounds, getCursor, getEventSource, getFactory, getFont, getForeground, getLocation, getLocationRelativeTo, getMaximumSize, getMinimumSize, getParent, getPreferredSize, getSize, getTabIndex, getToolTipText, isBackgroundSet, isCursorSet, isEnabled, isFocusable, isFontSet, isForegroundSet, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isVisible, requestFocus, setBackground, setBounds, setCursor, setEnabled, setEventSource, setFocusable, setFont, setForeground, setLocation, setLocationRelativeTo, setMaximumSize, setMinimumSize, setParent, setPreferredSize, setSize, setTabIndex, setToolTipText, setVisible

Methods inherited from interface javax.rad.ui.IResource

getResource

Methods inherited from interface javax.rad.ui.IAlignmentConstants

getHorizontalAlignment, getVerticalAlignment

Constructor Detail

SwingEditor

public SwingEditor()

Creates a new instance of SwingEditor.

Method Detail

getDataRow

public IDataRow getDataRow()

Returns the DataRow displayed by this control.

Specified by:

getDataRow in interface IEditorControl

Returns:

the DataRow.

See Also:

IEditorControl.setDataRow(javax.rad.model.IDataRow)

setDataRow

public void setDataRow(IDataRow pDataRow)
                throws ModelException

Sets the DataRow displayed by this control.

Specified by:

setDataRow in interface IEditorControl

Parameters:

pDataRow - the DataRow

Throws:

ModelException - if the column name is invalid

See Also:

IEditorControl.getDataRow(), IEditorControl.setColumnName(String)

getColumnName

public String getColumnName()

Returns the column name displayed by this control.

Specified by:

getColumnName in interface IEditorControl

Returns:

the column name.

See Also:

IEditorControl.setColumnName(java.lang.String)

setColumnName

public void setColumnName(String pColumnName)
                   throws ModelException

Sets the column name displayed by this control.

Specified by:

setColumnName in interface IEditorControl

Parameters:

pColumnName - the column name.

Throws:

ModelException - if the column name is invalid

See Also:

IEditorControl.getColumnName()

getCellEditor

public ICellEditor getCellEditor()

Gets the CellEditor that edits the given column in the given DataRow. If the CellEditor is null, the editor from the columns DataType is used to edit.

Specified by:

getCellEditor in interface IEditorControl

Specified by:

getCellEditor in interface IEditor

Returns:

the CellEditor.

See Also:

IEditorControl.setCellEditor(javax.rad.model.ui.ICellEditor)

setCellEditor

public void setCellEditor(ICellEditor pCellEditor)
                   throws ModelException

Sets the CellEditor that edits the given column in the given DataRow. If the CellEditor is null, the editor from the columns DataType is used to edit.

Specified by:

setCellEditor in interface IEditorControl

Specified by:

setCellEditor in interface IEditor

Parameters:

pCellEditor - the CellEditor.

Throws:

ModelException - if the column name of the editor is invalid

See Also:

IEditorControl.getCellEditor()

isSavingImmediate

public boolean isSavingImmediate()

Tells whether the CellEditor should save immediate.

Specified by:

isSavingImmediate in interface IEditor

Returns:

whether the CellEditor should save immediate.

setSavingImmediate

public void setSavingImmediate(boolean pSavingImmediate)

Sets whether the CellEditor should save immediate.

Specified by:

setSavingImmediate in interface IEditor

Parameters:

pSavingImmediate - true, if the CellEditor should save immediate.

cancelEditing

public void cancelEditing()

Informs the GUI control, that the last edit should be canceled(restored) the correct value is in the DataBook.

Specified by:

cancelEditing in interface IControl

notifyRepaint

public void notifyRepaint()

The control need to check if the part is visible and then repaint the part.

Specified by:

notifyRepaint in interface IControl

saveEditing

public void saveEditing()
                 throws ModelException

Informs the GUI control, that the last edit should be set into the IDataBook or IDataRow.

Specified by:

saveEditing in interface IControl

Throws:

ModelException - if the value can not be stored.

getCellFormatter

public ICellFormatter getCellFormatter()

Gets the cell formatter.

Specified by:

getCellFormatter in interface ICellFormatable

Returns:

the cell formatter.

setCellFormatter

public void setCellFormatter(ICellFormatter pCellFormatter)

Sets the cell formatter.

Specified by:

setCellFormatter in interface ICellFormatable

Parameters:

pCellFormatter - the cell formatter.

getCellFormat

public CellFormat getCellFormat(IDataBook pDataBook,
                                IDataPage pDataPage,
                                IDataRow pDataRow,
                                String pColumnName,
                                int pRow,
                                int pColumn)

Gets the format for the given cell.

Specified by:

getCellFormat in interface ICellFormatter

Parameters:

pDataBook - the DataBook

pDataPage - the DataPage

pDataRow - the DataRow

pColumnName - the column name

pRow - the Row number

pColumn - the Column number

Returns:

the format for the given cell.

setTranslation

public void setTranslation(TranslationMap pTranslation)

Sets the possible translations.

Specified by:

setTranslation in interface ITranslatable

Parameters:

pTranslation - the translation mapping

getTranslation

public TranslationMap getTranslation()

Gets the possible translation mapping.

Specified by:

getTranslation in interface ITranslatable

Returns:

the translation mapping

setTranslationEnabled

public void setTranslationEnabled(boolean pEnabled)

Sets the translation en- or disabled.

Specified by:

setTranslationEnabled in interface ITranslatable

Parameters:

pEnabled - true to enable the translation, false to disable

isTranslationEnabled

public boolean isTranslationEnabled()

Gets whether the translation is en- or disabled.

Specified by:

isTranslationEnabled in interface ITranslatable

Returns:

true if translation is performed, false otherwise

setBorderVisible

public void setBorderVisible(boolean pVisible)

Sets the border of the text field visible or invisible.

Specified by:

setBorderVisible in interface IEditor

Parameters:

pVisible - true to set the border visible or false to hide the border

isBorderVisible

public boolean isBorderVisible()

Returns whether the the border of the text field is visible.

Specified by:

isBorderVisible in interface IEditor

Returns:

true if the border is visible, false if the border is invisible

setHorizontalAlignment

public void setHorizontalAlignment(int pHorizontalAlignment)

Sets the horizontal alignment. Possible values are defined in AlignmentConstants.

Specified by:

setHorizontalAlignment in interface IAlignmentConstants

Overrides:

setHorizontalAlignment in class AwtComponent<JVxEditor>

Parameters:

pHorizontalAlignment - the new vertical alignment

setVerticalAlignment

public void setVerticalAlignment(int pVerticalAlignment)

Sets the vertical alignment. Possible values are defined in AlignmentConstants.

Specified by:

setVerticalAlignment in interface IAlignmentConstants

Overrides:

setVerticalAlignment in class AwtComponent<JVxEditor>

Parameters:

pVerticalAlignment - the new vertical alignment

getName

public String getName()

Gets the name of the object.

Implementing classes need to make sure that no name is set during the creation of the component. A unique name (based on the position of the component in the component tree) will be generated and set when the component is added, but only if the name of the component is null.

Specified by:

getName in interface IComponent

Specified by:

getName in interface INamedObject

Overrides:

getName in class AwtComponent<JVxEditor>

Returns:

this component's name

See Also:

IComponent.setName(java.lang.String)

setName

public void setName(String pName)

Sets the name of the object to the specified string.

Specified by:

setName in interface IComponent

Specified by:

setName in interface INamedObject

Overrides:

setName in class AwtComponent<JVxEditor>

Parameters:

pName - the string that is to be this component's name

See Also:

IComponent.getName()