com.klg.jclass.higrid
Class FolderIconStyle

java.lang.Object
  |
  +--com.klg.jclass.higrid.FolderIconStyle

All Implemented Interfaces:

Serializable

public class FolderIconStyle

extends Object

implements Serializable

The FolderIconStyle class defines the folder icon style to be used.

See Also:

Serialized Form

Field Summary

protected static int	DEFAULT_FOLDER_ICON_STYLE
protected static int	FIRST_FOLDER_ICON_STYLE
static int	FOLDER_ICON_STYLE_FOLDER Folder folder icon style.
static int	FOLDER_ICON_STYLE_LARGE_LINE_3D Large line 3D folder icon style.
static int	FOLDER_ICON_STYLE_MEDIUM_LINE_3D Medium line 3D folder icon style.
static int	FOLDER_ICON_STYLE_SHORTCUT Shortcut folder icon style.
static int	FOLDER_ICON_STYLE_SMALL_LINE_3D Small line 3D folder icon style.
static int	FOLDER_ICON_STYLE_TRIANGLE Triangle folder icon style.
static int	FOLDER_ICON_STYLE_TURNER Turner folder icon style.
static int	FOLDER_ICON_STYLE_USER_DEFINED User defined folder icon style.
protected static int	LAST_FOLDER_ICON_STYLE

Constructor Summary

FolderIconStyle(com.klg.jclass.higrid.HiGrid grid)
Constructor

Method Summary

Image	getFolderIcon(int type) Retrieves the current image for the specified folder state.
protected int	getMaximumHeight() Computes the maximum height of all of the icons.
protected int	getMaximumWidth() Computes the maximum width of all of the icons.
protected int	getStyle() Retrieves the folder style index.
protected void	recreateIcons() Allows lazy creation of icons and permits cut and paste serialization.
void	setFolderIcon(Image icon, int type) Sets the current image for the specified folder state.
protected void	setIcon(Image icon, int type) Sets the current image for the specified folder state.
protected void	setStyle(int style) Set the folder icons given the style index.
protected void	validateGridNodeWidth() Ensure that the entire node will be displayed.

Methods inherited from class java.lang.Object

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

Field Detail

FOLDER_ICON_STYLE_USER_DEFINED

public static final int FOLDER_ICON_STYLE_USER_DEFINED

User defined folder icon style.

See Also:

Constant Field Values

FOLDER_ICON_STYLE_SHORTCUT

public static final int FOLDER_ICON_STYLE_SHORTCUT

Shortcut folder icon style.

See Also:

Constant Field Values

FOLDER_ICON_STYLE_FOLDER

public static final int FOLDER_ICON_STYLE_FOLDER

Folder folder icon style.

See Also:

Constant Field Values

FOLDER_ICON_STYLE_TRIANGLE

public static final int FOLDER_ICON_STYLE_TRIANGLE

Triangle folder icon style.

See Also:

Constant Field Values

FOLDER_ICON_STYLE_SMALL_LINE_3D

public static final int FOLDER_ICON_STYLE_SMALL_LINE_3D

Small line 3D folder icon style.

See Also:

Constant Field Values

FOLDER_ICON_STYLE_MEDIUM_LINE_3D

public static final int FOLDER_ICON_STYLE_MEDIUM_LINE_3D

Medium line 3D folder icon style.

See Also:

Constant Field Values

FOLDER_ICON_STYLE_LARGE_LINE_3D

public static final int FOLDER_ICON_STYLE_LARGE_LINE_3D

Large line 3D folder icon style.

See Also:

Constant Field Values

FOLDER_ICON_STYLE_TURNER

public static final int FOLDER_ICON_STYLE_TURNER

Turner folder icon style.

See Also:

Constant Field Values

FIRST_FOLDER_ICON_STYLE

protected static final int FIRST_FOLDER_ICON_STYLE

See Also:

Constant Field Values

LAST_FOLDER_ICON_STYLE

protected static final int LAST_FOLDER_ICON_STYLE

See Also:

Constant Field Values

DEFAULT_FOLDER_ICON_STYLE

protected static final int DEFAULT_FOLDER_ICON_STYLE

See Also:

Constant Field Values

Constructor Detail

FolderIconStyle

public FolderIconStyle(com.klg.jclass.higrid.HiGrid grid)

Constructor

Method Detail

recreateIcons

protected void recreateIcons()

Allows lazy creation of icons and permits cut and paste serialization.

getMaximumHeight

protected int getMaximumHeight()

Computes the maximum height of all of the icons.

Returns:

The maximum height of all of the icons.

getMaximumWidth

protected int getMaximumWidth()

Computes the maximum width of all of the icons.

Returns:

The maximum width of all of the icons.

getStyle

protected int getStyle()

Retrieves the folder style index.

Returns:

The folder style index.

validateGridNodeWidth

protected void validateGridNodeWidth()

Ensure that the entire node will be displayed.

setStyle

protected void setStyle(int style)

Set the folder icons given the style index.

Parameters:

style - The style index.

getFolderIcon

public Image getFolderIcon(int type)

Retrieves the current image for the specified folder state.

Parameters:

type - The type of icon to get.

Returns:

The current icon of this type.

setFolderIcon

public void setFolderIcon(Image icon,
                          int type)

Sets the current image for the specified folder state.

Parameters:

type - The type of icon to set.

icon - The new icon of this type.

setIcon

protected void setIcon(Image icon,
                       int type)

Sets the current image for the specified folder state. This is for supplied folder styles.

Parameters:

type - The type of icon to set.

icon - The new icon of this type.