diamondedge.swing
Interface DsCell

All Superinterfaces:

DsCellProperties, DsConstants, SwingConstants

All Known Implementing Classes:

DsListCell, DsTableCell

public interface DsCell
extends DsCellProperties

A class to represent the properties and value for a cell in a grid or table table.

Field Summary

Fields inherited from interface diamondedge.swing.DsCellProperties

ALIGN_DEFAULT, ROTATE_0, ROTATE_270, ROTATE_90, ROTATE_DEFAULT

Fields inherited from interface diamondedge.swing.DsConstants

ACCOUNTING, ALL, ASCENDING, ASCENDING_CASE, BORDER_BOTTOM, BORDER_LEFT, BORDER_NONE, BORDER_OUTLINE, BORDER_RIGHT, BORDER_TOP, CROSS_LINES, DASH, DASH_DOT, DASH_DOT_DOT, DEFAULT, DESCENDING, DESCENDING_CASE, DIAGONAL_CROSS_LINES, DOT, DOUBLE, DOUBLE_LINE, DOWNWARD_DIAGONAL_LINES, ETCHED, ETCHED_RAISED, FALSE, FIND_ALL, FIND_EQUALS, FIND_GT, FIND_GTE, FIND_LT, FIND_LTE, FIND_NE, FIND_PREFIX, FIND_REGEX, FIND_STRING, FIRST, FLAT, GRID_DASH, GRID_DASH_DOT, GRID_DASH_DOT_DOT, GRID_DOT, GRID_LINE, HIGHLIGHT_SELECTION_ALWAYS, HIGHLIGHT_SELECTION_NEVER, HIGHLIGHT_SELECTION_WITH_FOCUS, HORIZONTAL_LINES, LOWERED, LOWERED_LIGHT, NONE, RAISED, RAISED_LIGHT, SELECT_CELL, SELECT_NONE, SELECT_ROW, SINGLE, SINGLE_LINE, SOLID, STRETCH, TILE, TRANSPARENT, TRUE, UPWARD_DIAGONAL_LINES, VERTICAL_LINES

Fields inherited from interface javax.swing.SwingConstants

BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Method Summary

int	getColumnSpan() Returns the number of columns this cell spans.
Object	getData() Returns a user defined object associated with the cell.
int	getRowSpan() Returns the number of rows this cell spans.
String	getText() Returns the formatted text to display in a cell of a table.
String	getToolTipText() Returns the text to display when the cursor is over the cell of a table.
Object	getValue() Returns the value being display in a cell of a table.
boolean	isVisible() Returns true if this cell is not hidden.
void	setData(Object userData) Sets a user defined object to be stored with the cell.
void	setText(String text) Sets the text to display in a cell of a table.
void	setToolTipText(String text) Sets the text to display when the cursor is over the cell of a table.
void	setValue(Object val) Sets the value for a cell of a table.

Methods inherited from interface diamondedge.swing.DsCellProperties

getBackground, getBorder, getBorderLineColor, getBorderLines, getBorderLineWidth, getBorderStyle, getFont, getFontName, getFontSize, getFontUnderline, getForeground, getFormat, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getRotation, getTextStyle, getVerticalAlignment, getVerticalTextPosition, isEditable, isFontBold, isFontItalic, isFontStrikeThrough, isNegativeNumberRed, isOpaque, isWordWrap, reset, setBackground, setBorder, setBorder, setBorder, setBorderLineColor, setBorderLines, setBorderLineWidth, setBorderStyle, setEditable, setFont, setFontBold, setFontItalic, setFontName, setFontSize, setFontStrikeThrough, setFontUnderline, setForeground, setFormat, setHorizontalAlignment, setHorizontalTextPosition, setIcon, setIcon, setNegativeNumberRed, setOpaque, setRotation, setTextStyle, setVerticalAlignment, setVerticalTextPosition, setWordWrap

Method Detail

getValue

Object getValue()

Returns the value being display in a cell of a table.

setValue

void setValue(Object val)

Sets the value for a cell of a table. The return value from toString() method will be displayed in the table. Note: this will not fire a tableChanged event. Set the value of the cell using the API of the component if an event is needed or if it is sorted.

getText

String getText()

Returns the formatted text to display in a cell of a table. This will use the format object to format the value of the cell.

See Also:

DsCellProperties.getFormat()

setText

void setText(String text)

Sets the text to display in a cell of a table. This is a convenience method that calls setValue(text).

getToolTipText

String getToolTipText()

Returns the text to display when the cursor is over the cell of a table.

setToolTipText

void setToolTipText(String text)

Sets the text to display when the cursor is over the cell of a table.

getData

Object getData()

Returns a user defined object associated with the cell.

setData

void setData(Object userData)

Sets a user defined object to be stored with the cell. This can be any type of object. The value is never used internally.

isVisible

boolean isVisible()

Returns true if this cell is not hidden. If this cell is hidden by another cell which has been spanned over the top then it returns false.

getRowSpan

int getRowSpan()

Returns the number of rows this cell spans. A number < 1 means the cell is that many rows away from the cell that is spanning multiple rows.

getColumnSpan

int getColumnSpan()

Returns the number of columns this cell spans. A number < 1 means the cell is that many columns away from the cell that is spanning multiple columns.