com.sssw.rt.tview
Class AgoColumnTextEditor

java.lang.Object
 |
 +--com.sssw.rt.tview.AgoColumnBase
       |
       +--com.sssw.rt.tview.AgoColumnText
             |
             +--com.sssw.rt.tview.AgoColumnTextEditor

public class AgoColumnTextEditor

extends AgoColumnText

AgoColumnTextEditor columns can be used to construct editable text columns for AgcView and AgcViewDownloadable controls.

Fields inherited from class com.sssw.rt.tview.AgoColumnText

MULTILINE

Constructor Summary

AgoColumnTextEditor(int width, boolean visible, boolean transparent, Color backgroundColor, int borderType)
Used to instantiate and set several properties for the AgoColumnTextEditor object.

Method Summary

boolean	getEditWhenSelected() Gets the state of the property which specifies whether cells in the column are always displayed as text editor cells, or are displayed as text editor cells only when selected by the user.
boolean	getTransparent() Return the transparent property.
void	setEditWhenSelected(boolean editWhenSelected) Sets the state of the property which specifies whether cells in the column are always displayed as text editor cells, or only when selected by the user.
void	setTransparent(boolean transparent) Sets the transparency property for this column.

Methods inherited from class com.sssw.rt.tview.AgoColumnText

applyFormat, getAdjustWidthForContent, getColor, getColumnName, getDatatype, getFontIdentifier, getFormatPattern, getFormatStyle, getMaxPointSize, getMinPointSize, getPropertyName, initColumnTextHeader, initColumnTextProperty, setAdjustWidthForContent, setColor, setColumnName, setFontIdentifier, setFormatPattern, setFormatStyle, setMaxPointSize, setMinPointSize, setPropertyName

Methods inherited from class com.sssw.rt.tview.AgoColumnBase

getAlignment, getBackgroundColor, getBorderType, getDisplayWidth, getHidden, getResizable, getSelectable, getVisible, getWidth, isWidthFixed, setAlignment, setBackgroundColor, setBorderType, setFixedWidth, setHidden, setProportionalWidth, setProportionalWidth, setResizable, setSelectable, setVisible, setWidth

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AgoColumnTextEditor

public AgoColumnTextEditor(int width,
                           boolean visible,
                           boolean transparent,
                           Color backgroundColor,
                           int borderType)

Used to instantiate and set several properties for the AgoColumnTextEditor object.

Parameters:

width - column width, in pixels

visible - true means column is visible

transparent - true means column is transparent

Color - background color of column

borderType - column border type

Usage:

For the borderType parameter, see the setBorderType() method.

Example:

	AgoColumnTextEditor colTxtEdit = new
		AgoColumnTextEditor(100, // width in pixels
			true,		// visible
			false,		// not transparent
			Color.white,	// background color
			AgoColumnBase.BORDER_3D);	// border type

See Also:

AgoColumnBase.setBorderType(int borderType)

Method Detail

getEditWhenSelected

public boolean getEditWhenSelected()

Gets the state of the property which specifies whether cells in the column are always displayed as text editor cells, or are displayed as text editor cells only when selected by the user. The default is true.

Usage:

If set to true, cells in the column are displayed as a text editor cells only when selected by the user. Otherwise, cells are always displayed as text editor cells. Text editor cells are visually different. They are displayed with a 3D border.

Example:

	boolean editOnSel = colTextEdit.getEditWhenSelected();

See Also:

AgoColumnTextEditor.setEditWhenSelected(boolean editWhenSelected)

setEditWhenSelected

public void setEditWhenSelected(boolean editWhenSelected)

Sets the state of the property which specifies whether cells in the column are always displayed as text editor cells, or only when selected by the user. The default is true.

Parameters:

editWhenSelected - if set to true, cells in the column are displayed as a text editor cells only when selected by the user. Otherwise, cells are always displayed as text editor cells. Text editor cells are visually different. They are displayed with a 3D border.

Example:

	colTextEdit.setEditWhenSelected(true);

See Also:

AgoColumnTextEditor.getEditWhenSelected()

getTransparent

public boolean getTransparent()

Return the transparent property.

Overrides:

getTransparent in class AgoColumnBase

Usage:

If set to true the column is transparent.

Example:

	boolean isTransparent = colTextEdit.getTransparent();

See Also:

AgoColumnTextEditor.setTransparent(boolean transparent)

setTransparent

public void setTransparent(boolean transparent)

Sets the transparency property for this column.

Overrides:

setTransparent in class AgoColumnBase

Parameters:

transparent - if set to true the column is transparent

Example:

	colTextEdit.setTransparent(true);

See Also:

AgoColumnTextEditor.getTransparent()