com.cc.framework.ui.model
Interface CrumbsDesignModel

All Superinterfaces:

AccessControlled, ActionBehavior, AjaxSupport, ClientHandler, ControlDesignModel, DesignModel

All Known Implementing Classes:

CrumbsDesignModelImp

public interface CrumbsDesignModel

extends ControlDesignModel

DesignModel for a CrumbsControl

Since:

1.3

Version:

$Revision: 1.5 $

Author:

Harald Schulz

Method Summary

CrumbsDesignModel	addCrumb(CrumbModel crumb) Adds a single Crumb
boolean	filter() Returns if the filter is activated (default=true).
CrumbModel[]	getCrumbs() Returns an Array with all Crumbs
ImageMap	getImageMap() Returns the ImageMap
int	getLabelLength() Returns the maximal length for labels
void	removeCrumb(CrumbModel crumb) Removes a Crumb from the CrumbControl
void	setFilter(boolean filter) Activates the HTML encoding (filter).
void	setImageMap(ImageMap map) Sets the ImageMap
void	setLabelLength(int length) Sets the maximal length for labels shown on a Crumb If a label is longer as the size defined here, it will be cut.
int	size() Returns the total Number of Crumbs

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

Method Detail

addCrumb

public CrumbsDesignModel addCrumb(CrumbModel crumb)

Adds a single Crumb

Parameters:

crumb - CrumbDesignModel

Returns:

TabsetDesignModel

removeCrumb

public void removeCrumb(CrumbModel crumb)

Removes a Crumb from the CrumbControl

Parameters:

crumb - Crumb to be removed

getCrumbs

public CrumbModel[] getCrumbs()

Returns an Array with all Crumbs

Returns:

CrumbDesignModel

size

public int size()

Returns the total Number of Crumbs

Returns:

integer

setImageMap

public void setImageMap(ImageMap map)

Sets the ImageMap

Parameters:

map - ImageMap

getImageMap

public ImageMap getImageMap()

Returns the ImageMap

Returns:

ImageMap

setLabelLength

public void setLabelLength(int length)

Sets the maximal length for labels shown on a Crumb If a label is longer as the size defined here, it will be cut.

Parameters:

length - LabelLength

getLabelLength

public int getLabelLength()

Returns the maximal length for labels

Returns:

integer

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