com.sssw.rt.tview
Class AgoColumnHierarchy

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

public final class AgoColumnHierarchy

extends AgoColumnText

This class is used to define the format properties of a hierarchical column.

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

MULTILINE

Constructor Summary

AgoColumnHierarchy(int width, boolean visible, boolean transparent, Color backgroundColor, int borderType)
AgoColumnHierarchy constructor.

Method Summary

boolean	getCollapseExpandOnDoubleClick() Determine if the collapse/expand on doubleclick property is active.
boolean	getEnableCollapseExpandControl() Determines whether the collapse/expand indicator ("twistie") is enabled or not.
int	getImageHeight() Gets the image height, in pixels.
int	getImageWidth() Gets the image width, in pixels.
int	getIndentPixels() Gets the amount, in pixels, by which the image is indented in each successive level of the hierarchy.
int	getLeftMargin() Get the left margin.
boolean	getShowCollapseExpandControl() Determines whether the collapse/expand indicator ("twistie") is being displayed or not.
boolean	getShowHorizontalRule() Gets the show horizontal rule property.
void	setCollapseExpandOnDoubleClick(boolean collapseexpand) Sets the collapse/expand on double-click property.
void	setEnableCollapseExpandControl(boolean collapseexpandcontrol) Specifies whether the collapse/expand indicator ("twistie") is to be enabled or not
void	setImageHeight(int imageheight) Sets the image height.
void	setImageName(String imagename) Specifies the name of the property which specifies the image to be used in this column.
void	setImageWidth(int imagewidth) Sets the image width.
void	setIndentPixels(int indentpixels) Sets the amount, in pixels, by which the image is indented in each successive level of the hierarchy.
void	setLeftMargin(int margin) Set the left margin.
void	setShowCollapseExpandControl(boolean collapseexpandcontrol) Specifies whether the collapse/expand indicator ("twistie") is to be displayed or not
void	setShowHorizontalRule(boolean horizontalrule) Sets the show horizontal rule property.

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, getTransparent, getVisible, getWidth, isWidthFixed, setAlignment, setBackgroundColor, setBorderType, setFixedWidth, setHidden, setProportionalWidth, setProportionalWidth, setResizable, setSelectable, setTransparent, setVisible, setWidth

Methods inherited from class java.lang.Object

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

Constructor Detail

AgoColumnHierarchy

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

AgoColumnHierarchy constructor. Allows several column hierarchy properties to be set.

Parameters:

width - the column width, in pixels

visible - true means column is visible

transparent - true means column is transparent

Color - background color of column

borderType - border type

Usage:

For the borderType parameter, see the setBorderType method.

Example:

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

See Also:

AgoColumnBase.setBorderType(int borderType)

Method Detail

setImageName

public void setImageName(String imagename)

Specifies the name of the property which specifies the image to be used in this column.

Parameters:

imagename - name of the property whose value is the filename of the image

Example:

	// set the property from which the image filename is to be retrieved -
	// in this case, the property "Image" should have as its value the image filename
	colHier.setImageName("Image");

getLeftMargin

public int getLeftMargin()

Get the left margin. By default the expand/collapse indicator is drawn at the far left of the cell for rows at the top of the hierarchy (rows with an indent level of 0). The left margin is used to add blank space to the left of the expand/collapse indicator.

See Also:

AgoColumnHierarchy.setLeftMargin(int margin)

setLeftMargin

public void setLeftMargin(int margin)

Set the left margin. By default the expand/collapse indicator is drawn at the far left of the cell for rows at the top of the hierarchy (rows with an indent level of 0). The left margin is used to add blank space to the left of the expand/collapse indicator.

Parameters:

margin -

See Also:

AgoColumnHierarchy.getLeftMargin()

getImageWidth

public int getImageWidth()

Gets the image width, in pixels.

Example:

	int imgWidth = colHier.getImageWidth();

See Also:

AgoColumnHierarchy.setImageWidth(int imagewidth)

setImageWidth

public void setImageWidth(int imagewidth)

Sets the image width.

Parameters:

imagewidth - image width, in pixel units.

Example:

	colHier.setImageWodth(20);

See Also:

AgoColumnHierarchy.getImageWidth()

getImageHeight

public int getImageHeight()

Gets the image height, in pixels.

Example:

	int imgHeight = colHier.getImageHeight();

See Also:

AgoColumnHierarchy.setImageHeight(int imageheight)

setImageHeight

public void setImageHeight(int imageheight)

Sets the image height.

Parameters:

imageheight - image height, in pixels.

Example:

	colHier.setImageHeight(50);

See Also:

AgoColumnHierarchy.getImageHeight()

getIndentPixels

public int getIndentPixels()

Gets the amount, in pixels, by which the image is indented in each successive level of the hierarchy.

Example:

	int imgIndent = colHier.getIndentPixels();

See Also:

AgoColumnHierarchy.setIndentPixels(int indentpixels)

setIndentPixels

public void setIndentPixels(int indentpixels)

Sets the amount, in pixels, by which the image is indented in each successive level of the hierarchy.

Parameters:

indentpixels - Indent per level, in pixels

Example:

	colHier.setIndentPixels(20);

See Also:

AgoColumnHierarchy.getIndentPixels()

getShowCollapseExpandControl

public boolean getShowCollapseExpandControl()

Determines whether the collapse/expand indicator ("twistie") is being displayed or not.

Usage:

If true means the "twistie" control is being displayed.

Example:

	boolean twistieShowing = colHier.getShowCollapseExpandControl();

See Also:

AgoColumnHierarchy.getEnableCollapseExpandControl(), AgoColumnHierarchy.setShowCollapseExpandControl(boolean collapseexpandcontrol)

setShowCollapseExpandControl

public void setShowCollapseExpandControl(boolean collapseexpandcontrol)

Specifies whether the collapse/expand indicator ("twistie") is to be displayed or not

Parameters:

collapseexpandcontrol - If set to true the "twistie" control is displayed.

Example:

	colHier.setShowCollapseExpandControl(true);

See Also:

AgoColumnHierarchy.getShowCollapseExpandControl(), AgoColumnHierarchy.getEnableCollapseExpandControl(), AgoColumnHierarchy.setEnableCollapseExpandControl(boolean collapseexpandcontrol)

getEnableCollapseExpandControl

public boolean getEnableCollapseExpandControl()

Determines whether the collapse/expand indicator ("twistie") is enabled or not.

Example:

	boolean twistieActive = colHier.getEnableCollapseExpandControl();

See Also:

AgoColumnHierarchy.getShowCollapseExpandControl(), AgoColumnHierarchy.setEnableCollapseExpandControl(boolean collapseexpandcontrol)

setEnableCollapseExpandControl

public void setEnableCollapseExpandControl(boolean collapseexpandcontrol)

Specifies whether the collapse/expand indicator ("twistie") is to be enabled or not

Parameters:

collapseexpandcontrol - If set to true the "twistie" control is displayed.

Example:

	colHier.setEnableCollapseExpandControl(true);

See Also:

AgoColumnHierarchy.getEnableCollapseExpandControl(), AgoColumnHierarchy.getShowCollapseExpandControl(), AgoColumnHierarchy.setShowCollapseExpandControl(boolean collapseexpandcontrol)

getShowHorizontalRule

public boolean getShowHorizontalRule()

Gets the show horizontal rule property.

Usage:

If true a horizontal line is displayed from the end of the text to the end of the cell.

Example:

	boolean showingRule = colHier.getShowHorizontalRule();

See Also:

AgoColumnHierarchy.setShowHorizontalRule(boolean horizontalrule)

setShowHorizontalRule

public void setShowHorizontalRule(boolean horizontalrule)

Sets the show horizontal rule property.

Parameters:

horizontalrule - If set to true, a horizontal line is displayed from the end of the text to the end of the cell.

Example:

	colHier.setShowHorizontalRule(true);

See Also:

AgoColumnHierarchy.getShowHorizontalRule()

getCollapseExpandOnDoubleClick

public boolean getCollapseExpandOnDoubleClick()

Determine if the collapse/expand on doubleclick property is active.

Usage:

If true, column expands (shows children) or collapses (hides children) on double-click by user.

Example:

	boolean willCollapse = colHier.getCollapseExpandOnDoubleClick();

See Also:

AgoColumnHierarchy.setCollapseExpandOnDoubleClick(boolean collapseexpand)

setCollapseExpandOnDoubleClick

public void setCollapseExpandOnDoubleClick(boolean collapseexpand)

Sets the collapse/expand on double-click property.

Parameters:

collapseexpand - If set to true the column expands/collapses on double-click by user.

Example:

	colHier.setCollapseExpandOnDoubleClick(false);

See Also:

AgoColumnHierarchy.getCollapseExpandOnDoubleClick()