com.cc.framework.ui.model
Interface TreeStyle

All Known Subinterfaces:

TreeDesignModel, TreelistDesignModel

All Known Implementing Classes:

TreeDesignModelImp, TreelistDesignModelImp

public interface TreeStyle

The interface defines the styles of a tree element

Since:

1.0

Version:

$Revision: 1.20 $

Author:

Harald Schulz

Method Summary

java.lang.String	getEnableProperty() Liefert den Namen der Eigenschaft, welche die Spaltendaten ermittelt, zurück
ExpansionMode	getExpansionMode() Returns the expansion state.
boolean	getGroupSelect() Returns if the group nodes are selectabel.
SelectMode	getSelectMode() Returns the the selection mode of the list.
java.lang.String	getStyle() Returns the HTML-style
java.lang.String	getStyleClass() Returns the HTML-class attribute
java.lang.String	getStyleId() Returns the HTML-id attribute
java.lang.String	getTarget() Returns the target attribute.
java.lang.String	getTargetProperty() Returns the name of the property.
java.lang.String	getTooltipProperty() Returns the name of the property.
boolean	isDisabled() Returns the disabled Flag
void	setDisabled(boolean disabled) Sets the disabled Flag
void	setEnableProperty(java.lang.String property) Setzt den Namen der Eigenschaft mit deren Hilfe der Spaltenwert bestimmt werden kann.
void	setExpansionMode(ExpansionMode mode) Sets the expansion state
void	setGroupSelect(boolean select) Defines if the group nodes should be selectabel.
void	setLabelWrap(boolean wrap) Sets the label wrapping behavior
void	setSelectMode(SelectMode mode) Specifies the selection mode of the list.
void	setStyle(java.lang.String style) An HTML-style can be directly specified with this attribute.
void	setStyleClass(java.lang.String styleClass) The HTML-class attribute of the element can be specified with this attribute.
void	setStyleId(java.lang.String id) The HTML-id attribute of the element can be specified with this attribute
void	setTarget(java.lang.String target) Defines a target attribute which should be inserted in all generated hyperlinks of the columns.
void	setTargetProperty(java.lang.String targetProperty) Specifies the name of a property with the help of which the relevant line can generate an HTML-target attribute.
void	setTooltipProperty(java.lang.String tooltipProperty) Specifies the name of a property with the help of which the relevant line can generate an HTML-text attribute.
boolean	showButtons() Returns if the icons for expanding a node are displayed.
void	showButtons(boolean show) Defines if the icons for expanding a node should be displayed.
boolean	showCheckBoxes() Returns if a checkbox is displayed before the tree entries.
void	showCheckBoxes(boolean show) Indicates whether a checkbox should be displayed before the tree entries The tree entries must implement the Checkable Interface, so that the control element can draw the checkboxes.
boolean	showLines() Returns if a line between the nodes is displayed.
void	showLines(boolean show) Defines if a line between the nodes should be displayed.
boolean	showLinesAtRoot() Returns whether lines should be drawn to the construction elements of the uppermost (displayed) level.
void	showLinesAtRoot(boolean show) Specifies whether lines should be drawn to the construction elements of the uppermost (displayed) level.
boolean	showRoot() Returns if the root element should be displayed
void	showRoot(boolean show) Specifies whether the root of the tree element should be displayed.
boolean	wrapLabels()

Method Detail

getExpansionMode

public ExpansionMode getExpansionMode()

Returns the expansion state.

• FULL = All nodes are shown exploded at all times. The user cannot close any node.
• SINGLE = Only one branch can be exploded.
• MULTIPLE = As many branches as desired can be exploded.

Returns:

The expansion mode

setExpansionMode

public void setExpansionMode(ExpansionMode mode)

Sets the expansion state

Parameters:

mode - The expansion mode

showButtons

public boolean showButtons()

Returns if the icons for expanding a node are displayed. Note: The class which implements this interface must be aware of the settings of the expansion mode. If the nodes are always expanded this method should return false.

Returns:

boolean

showButtons

public void showButtons(boolean show)

Defines if the icons for expanding a node should be displayed.

Parameters:

show - true if the icons should be displayed;
false otherwise.

showLines

public boolean showLines()

Returns if a line between the nodes is displayed.

Returns:

true if a line between the nodes is displayed;
false otherwise.

showLines

public void showLines(boolean show)

Defines if a line between the nodes should be displayed.

Parameters:

show - true if a line between the nodes should be displayed;
false otherwise.

showLinesAtRoot

public boolean showLinesAtRoot()

Returns whether lines should be drawn to the construction elements of the uppermost (displayed) level.

Returns:

boolean

showLinesAtRoot

public void showLinesAtRoot(boolean show)

Specifies whether lines should be drawn to the construction elements of the uppermost (displayed) level.

Parameters:

show - true if the line should be visible on the uppermost level; false otherwise

showRoot

public boolean showRoot()

Returns if the root element should be displayed

Returns:

boolean true if the root element should be displayed; false otherwise

showRoot

public void showRoot(boolean show)

Specifies whether the root of the tree element should be displayed.

Parameters:

show - true if the root element should be displayed

showCheckBoxes

public boolean showCheckBoxes()

Returns if a checkbox is displayed before the tree entries.

Returns:

boolean true if a checkbox is displayed;
false otherwise

showCheckBoxes

public void showCheckBoxes(boolean show)

Indicates whether a checkbox should be displayed before the tree entries
The tree entries must implement the Checkable Interface, so that the control element can draw the checkboxes. Group nodes must not implement this interface, since the Check-State of groups can be automatically calculated with the help of the state of the pages.

Parameters:

show - true if checkbox should be displayed;
false otherwise

setGroupSelect

public void setGroupSelect(boolean select)

Defines if the group nodes should be selectabel.

Parameters:

select - true if the group nodes should be selectabel;
false otherwise

getGroupSelect

public boolean getGroupSelect()

Returns if the group nodes are selectabel.

Returns:

boolean true if the group nodes are selectabel;
false otherwise

setTarget

public void setTarget(java.lang.String target)

Defines a target attribute which should be inserted in all generated hyperlinks of the columns.
Note: The same attribute will be used in all rows!

Parameters:

target - The target attribute

getTarget

public java.lang.String getTarget()

Returns the target attribute.

Returns:

The target attribute.

setTargetProperty

public void setTargetProperty(java.lang.String targetProperty)

Specifies the name of a property with the help of which the relevant line can generate an HTML-target attribute.
Note: Valid Java designator/label. The Row-Bean must implement a suitable property-getter method. The attribute can be defined individual within each row (In difference to the method setTarget)

Parameters:

targetProperty - The name of the property to use

getTargetProperty

public java.lang.String getTargetProperty()

Returns the name of the property.

Returns:

The name of the property.

setTooltipProperty

public void setTooltipProperty(java.lang.String tooltipProperty)

Specifies the name of a property with the help of which the relevant line can generate an HTML-text attribute. Note: Valid Java designator/label. The Row-Bean must implement a suitable property-getter method. The attribute can be defined individual within each row

Parameters:

tooltipProperty - The target attribute

getTooltipProperty

public java.lang.String getTooltipProperty()

Returns the name of the property.

Returns:

The name of the property.

getSelectMode

public SelectMode getSelectMode()

Returns the the selection mode of the list.

• NONE = not selectable.
• SINGLE = single selection.
• MULTIPLE = multiple selection.

Returns:

SelectMode

setSelectMode

public void setSelectMode(SelectMode mode)

Specifies the selection mode of the list.
This is only used if a Check column is to be displayed here as well.

Parameters:

mode - The select mode

setStyleId

public void setStyleId(java.lang.String id)

The HTML-id attribute of the element can be specified with this attribute

Parameters:

id - The HTML-id attribute

getStyleId

public java.lang.String getStyleId()

Returns the HTML-id attribute

Returns:

The HTML-id attribute

setStyleClass

public void setStyleClass(java.lang.String styleClass)

The HTML-class attribute of the element can be specified with this attribute.

Parameters:

styleClass - The HTML-class attribute

getStyleClass

public java.lang.String getStyleClass()

Returns the HTML-class attribute

Returns:

The HTML-class attribute

setStyle

public void setStyle(java.lang.String style)

An HTML-style can be directly specified with this attribute.

Parameters:

style - The HTML-Style

getStyle

public java.lang.String getStyle()

Returns the HTML-style

Returns:

The HTML-style

getEnableProperty

public java.lang.String getEnableProperty()

Liefert den Namen der Eigenschaft, welche die Spaltendaten ermittelt, zurück

Returns:

Property

setEnableProperty

public void setEnableProperty(java.lang.String property)

Setzt den Namen der Eigenschaft mit deren Hilfe der Spaltenwert bestimmt werden kann.

Parameters:

property - Der Name der Eigenschaft

setDisabled

public void setDisabled(boolean disabled)

Sets the disabled Flag

Parameters:

disabled - true if the control should be rendered as inactive

isDisabled

public boolean isDisabled()

Returns the disabled Flag

Returns:

boolean

wrapLabels

public boolean wrapLabels()

Returns:

returns true when the tree should wrap labels

setLabelWrap

public void setLabelWrap(boolean wrap)

Sets the label wrapping behavior

Parameters:

wrap - true to wrap labels