com.cc.framework.ui.model
Interface TreeDesignModel

All Superinterfaces:

AccessControlled, ActionBehavior, AjaxSupport, ClientHandler, ControlDesignModel, DesignModel, ScrollSupport, TreeStyle

All Known Implementing Classes:

TreeDesignModelImp

public interface TreeDesignModel

extends ControlDesignModel, ScrollSupport, TreeStyle

This interface defines the visual attributes of a tree.

Since:

1.0

Version:

$Revision: 1.9 $

Author:

Harald Schulz

Method Summary

boolean	filter() Returns if the filter is activated (default=true).
ImageMap	getImageMap() Returns the associated ImageMap
java.lang.String	getImageProperty() Returns the image property
java.lang.String	getLabelProperty() Returns the Property which should be used to get the labels for the Nodes
int	getMaxLength() Returns the maximal number of input characters which can be inserted into the text field.
int	getRowCount() Returns the maximum number of lines that are depicted simultaneously.
void	setFilter(boolean filter) Activates the HTML encoding (filter).
void	setImageMap(ImageMap map) Specifies the name of an image map.
void	setImageProperty(java.lang.String property) Specifies the property using which an image can be assigned to every Row-Bean
void	setLabelProperty(java.lang.String property) Specifies the property using which a label can be assigned to every Row-Bean.
void	setMaxLength(int max) Sets the maximal number of input characters which can be inserted into the text field.
void	setRowCount(int rows) This attribute is used to specify the maximum number of lines that are depicted simultaneously.

Methods inherited from interface com.cc.framework.ui.model.ControlDesignModel

addDesignRule, getAction, getBorder, getDesignRules, getHeight, getHelp, getId, getLocaleName, getName, getProperty, getRunAt, getStyle, getStyleClass, getStyleId, getSummary, getTabIndex, getTooltip, getTransaction, getWidth, hasShadow, isDisabled, isDynamicDesignModel, isFormElement, setAction, setBorder, setDisabled, setDynamicDesignModel, setFormElement, setHeight, setHelp, setId, setLocaleName, setName, setPermission, setProperty, setRunAt, setShadow, setStyle, setStyleClass, setStyleId, setSummary, setTabIndex, setTooltip, setTransaction, setWidth

Methods inherited from interface com.cc.framework.ui.model.ClientHandler

getHandler, getHandlers, setHandler

Methods inherited from interface com.cc.framework.ui.model.AccessControlled

getPermission, show

Methods inherited from interface com.cc.framework.ui.model.ActionBehavior

isAjaxEnabled

Methods inherited from interface com.cc.framework.ui.model.AjaxSupport

enableAjax, isAjaxEnabled

Methods inherited from interface com.cc.framework.ui.model.ScrollSupport

getScrollHeight, setScrollHeight

Methods inherited from interface com.cc.framework.ui.model.TreeStyle

getEnableProperty, getExpansionMode, getGroupSelect, getSelectMode, getStyle, getStyleClass, getStyleId, getTarget, getTargetProperty, getTooltipProperty, isDisabled, setDisabled, setEnableProperty, setExpansionMode, setGroupSelect, setLabelWrap, setSelectMode, setStyle, setStyleClass, setStyleId, setTarget, setTargetProperty, setTooltipProperty, showButtons, showButtons, showCheckBoxes, showCheckBoxes, showLines, showLines, showLinesAtRoot, showLinesAtRoot, showRoot, showRoot, wrapLabels

Method Detail

getRowCount

public int getRowCount()

Returns the maximum number of lines that are depicted simultaneously. When the total number of available lines in the data model is greater than the number of lines displayed, buttons are automatically generated for navigation through pages.

Returns:

Number of rows to show per page. -1 means that all rows are displayed.

setRowCount

public void setRowCount(int rows)

This attribute is used to specify the maximum number of lines that are depicted simultaneously.

Parameters:

rows - The number of rows to show

setImageProperty

public void setImageProperty(java.lang.String property)

Specifies the property using which an image can be assigned to every Row-Bean

Parameters:

property - Name of the property

getImageProperty

public java.lang.String getImageProperty()

Returns the image property

Returns:

Name of the property

setLabelProperty

public void setLabelProperty(java.lang.String property)

Specifies the property using which a label can be assigned to every Row-Bean.

Parameters:

property - Name of the property

getLabelProperty

public java.lang.String getLabelProperty()

Returns the Property which should be used to get the labels for the Nodes

Returns:

Name of the property

setImageMap

public void setImageMap(ImageMap map)

Specifies the name of an image map.

Parameters:

map - ImageMap

getImageMap

public ImageMap getImageMap()

Returns the associated ImageMap

Returns:

ImageMap

filter

public boolean filter()

Returns if the filter is activated (default=true). This means that all Strings which should be displayed in the HTML page are HTML encoded

Returns:

true if string will be HTML encoded; false otherwise

setFilter

public void setFilter(boolean filter)

Activates the HTML encoding (filter). Default is true. This means that all Strings which should be displayed in the HTML page will be HTML encoded.

Parameters:

filter - true if strings should be HTML encoded; false otherwise

getMaxLength

public int getMaxLength()

Returns the maximal number of input characters which can be inserted into the text field.

Returns:

Maximum number of input characters to accept

setMaxLength

public void setMaxLength(int max)

Sets the maximal number of input characters which can be inserted into the text field.

Parameters:

max - Maximum number of input characters to accept