com.klg.jclass.higrid
Interface CellStyleModel

All Superinterfaces:

Cloneable

All Known Implementing Classes:

CellStyle

public interface CellStyleModel

extends Cloneable

The CellStyleModel class provides CellRenderer and CellEditor objects formatting information that can be used in drawing.

Method Summary

void	copyFromCellStyle(com.klg.jclass.higrid.CellStyleModel cellStyleModel) Replaces cellStyleModel attributes with the passed one.
void	copyPlafFromCellStyle(com.klg.jclass.higrid.CellStyleModel cellStyleModel) Replaces PLAF cellStyleModel attributes with the passed one, only if the PLAF attributes were not already overridden.
boolean	getAllowWidthSizing() Retrieves whether width sizing is currently allowed.
Color	getBackground() Retrieves the background color for this object.
Insets	getBorderInsets() Retrieves the border insets for this object.
int	getBorderStyle() Retrieves the border style for this object.
int	getClipHints() Determines whether the renderer should draw some indication if the entire contents of the cell cannot be rendered within the given area.
int	getEditHeightPolicy() Retrieves the edit height policy for this object.
int	getEditWidthPolicy() Retrieves the edit width policy for this object.
Font	getFont() Retrieves the font for this object.
Color	getForeground() Retrieves the foreground color for this object.
int	getHorizontalAlignment() Retrieves the horizontal alignment for this object.
Insets	getMarginInsets() Retrieves the margin insets for this object.
boolean	getSelectAll() Determines whether the editor should select the contents before editing.
Color	getSelectedBackground() Retrieves the selected background color for this object.
Color	getSelectedForeground() Retrieves the selected foreground color for this object.
int	getVerticalAlignment() Retrieves the vertical alignment for this object.
void	setAllowWidthSizing(boolean allow) Sets whether width sizing is currently allowed.
void	setBackground(Color color) Sets the background color for this object.
void	setBorderInsets(Insets insets) Sets the border insets for this object.
void	setBorderStyle(int style) Sets the border style for this object.
void	setClipHints(int clipHints) Determines whether the renderer should draw some indication if the entire contents of the cell cannot be rendered within the given area.
void	setEditHeightPolicy(int policy) Sets the edit height policy for this object.
void	setEditWidthPolicy(int policy) Sets the edit width policy for this object.
void	setFont(Font font) Sets the font for this object.
void	setForeground(Color color) Sets the foreground color for this object.
void	setHorizontalAlignment(int alignment) Sets the horizontal alignment for this object.
void	setMarginInsets(Insets insets) Sets the margin insets for this object.
void	setOtherAllowWidthSizing(boolean allow) Sets whether width sizing is currently allowed for the other header/record pair.
void	setSelectAll(boolean selectAll) Determines whether the editor should select the contents before editing.
void	setSelectedBackground(Color color) Sets the selected background color for this object.
void	setSelectedForeground(Color color) Sets the selected foreground color for this object.
void	setVerticalAlignment(int alignment) Sets the vertical alignment for this object.

Method Detail

getBackground

public Color getBackground()

Retrieves the background color for this object.

Returns:

The current background color.

setBackground

public void setBackground(Color color)

Sets the background color for this object.

Parameters:

color - The new background color.

Throws:

IllegalArgumentException - If parameter is null.

getForeground

public Color getForeground()

Retrieves the foreground color for this object.

Returns:

The current foreground color.

setForeground

public void setForeground(Color color)

Sets the foreground color for this object.

Parameters:

color - The new foreground color.

Throws:

IllegalArgumentException - If parameter is null.

getSelectedBackground

public Color getSelectedBackground()

Retrieves the selected background color for this object.

Returns:

The current selected background color.

setSelectedBackground

public void setSelectedBackground(Color color)

Sets the selected background color for this object.

Parameters:

color - The new selected background color.

Throws:

IllegalArgumentException - If parameter is null.

getSelectedForeground

public Color getSelectedForeground()

Retrieves the selected foreground color for this object.

Returns:

The current selected foreground color.

setSelectedForeground

public void setSelectedForeground(Color color)

Sets the selected foreground color for this object.

Parameters:

color - The new selected foreground color.

Throws:

IllegalArgumentException - If parameter is null.

getBorderStyle

public int getBorderStyle()

Retrieves the border style for this object.

Returns:

The current border style.

setBorderStyle

public void setBorderStyle(int style)

Sets the border style for this object.

Parameters:

style - The new border style.

getBorderInsets

public Insets getBorderInsets()

Retrieves the border insets for this object.

Returns:

The current border insets.

setBorderInsets

public void setBorderInsets(Insets insets)

Sets the border insets for this object.

getVerticalAlignment

public int getVerticalAlignment()

Retrieves the vertical alignment for this object.

Returns:

The current vertical alignment.

setVerticalAlignment

public void setVerticalAlignment(int alignment)

Sets the vertical alignment for this object.

Parameters:

alignment - The new vertical alignment.

getHorizontalAlignment

public int getHorizontalAlignment()

Retrieves the horizontal alignment for this object.

Returns:

The current horizontal alignment.

setHorizontalAlignment

public void setHorizontalAlignment(int alignment)

Sets the horizontal alignment for this object.

Parameters:

alignment - The new horizontal alignment.

getEditWidthPolicy

public int getEditWidthPolicy()

Retrieves the edit width policy for this object.

Returns:

The current edit width policy.

setEditWidthPolicy

public void setEditWidthPolicy(int policy)

Sets the edit width policy for this object.

Parameters:

policy - The new edit width policy.

getEditHeightPolicy

public int getEditHeightPolicy()

Retrieves the edit height policy for this object.

Returns:

The current edit height policy.

setEditHeightPolicy

public void setEditHeightPolicy(int policy)

Sets the edit height policy for this object.

Parameters:

policy - The new edit height policy.

getMarginInsets

public Insets getMarginInsets()

Retrieves the margin insets for this object.

Returns:

The current margin insets.

setMarginInsets

public void setMarginInsets(Insets insets)

Sets the margin insets for this object.

Parameters:

insets - The new margin insets.

getFont

public Font getFont()

Retrieves the font for this object.

Returns:

The current font.

setFont

public void setFont(Font font)

Sets the font for this object.

Parameters:

font - The new font.

Throws:

IllegalArgumentException - If parameter is null.

getAllowWidthSizing

public boolean getAllowWidthSizing()

Retrieves whether width sizing is currently allowed.

Returns:

Whether width sizing is currently allowed.

setAllowWidthSizing

public void setAllowWidthSizing(boolean allow)

Sets whether width sizing is currently allowed.

Parameters:

allow - Whether to allow width sizing.

setOtherAllowWidthSizing

public void setOtherAllowWidthSizing(boolean allow)

Sets whether width sizing is currently allowed for the other header/record pair.

Parameters:

allow - Whether to allow width sizing.

getSelectAll

public boolean getSelectAll()

Determines whether the editor should select the contents before editing.

setSelectAll

public void setSelectAll(boolean selectAll)

Determines whether the editor should select the contents before editing.

getClipHints

public int getClipHints()

Determines whether the renderer should draw some indication if the entire contents of the cell cannot be rendered within the given area.

setClipHints

public void setClipHints(int clipHints)

Determines whether the renderer should draw some indication if the entire contents of the cell cannot be rendered within the given area.

copyFromCellStyle

public void copyFromCellStyle(com.klg.jclass.higrid.CellStyleModel cellStyleModel)

Replaces cellStyleModel attributes with the passed one.

copyPlafFromCellStyle

public void copyPlafFromCellStyle(com.klg.jclass.higrid.CellStyleModel cellStyleModel)

Replaces PLAF cellStyleModel attributes with the passed one, only if the PLAF attributes were not already overridden.