com.cc.framework.ui.model
Interface CrumbModel

All Superinterfaces:

AccessControlled, ClientHandler, DesignModel

All Known Implementing Classes:

CrumbModelImp

public interface CrumbModel

extends DesignModel, ClientHandler, AccessControlled

Designmodel for a Crumb

Since:

1.3

Version:

$Revision: 1.7 $

Author:

Harald Schulz

Method Summary

java.lang.Boolean	filter() Returns if the filter is activated (default=true).
java.lang.String	getAction() Returns the action, which should be processed if the Crumb is selected.
java.lang.String	getCrumbId() Returns the unique key for the Crumb
java.lang.String	getImageRef() Returns the assignment Rule
java.lang.String	getLocaleName() Gets the Local Setting for this element
java.lang.String	getTitle() Returns the Title
java.lang.String	getTooltip() Returns the tooltip
boolean	isDisabled() Checks if the crumb is disabled
void	setAction(java.lang.String action) Sets the Action, which should be processed if the Crumb is selected.
void	setCrumbId(java.lang.String crumbid) Sets the Id for the Crumb
void	setDisabled(boolean disabled) Marks the crumb as disabled
void	setFilter(boolean filter) Activates the HTML encoding (filter).
void	setImageRef(java.lang.String ref) Assigns the Crumb an Image from an ImageMap
void	setLocaleName(java.lang.String locale) Sets the Locale configuration for this element
void	setPermission(Permission permission) Sets a list with permission for the object.
void	setTitle(java.lang.String title) Sets the Title
void	setTooltip(java.lang.String tooltip) Sets the tooltip text

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

Method Detail

getCrumbId

public java.lang.String getCrumbId()

Returns the unique key for the Crumb

Returns:

The id of the crumb

setCrumbId

public void setCrumbId(java.lang.String crumbid)

Sets the Id for the Crumb

Parameters:

crumbid - Unique Id

getAction

public java.lang.String getAction()

Returns the action, which should be processed if the Crumb is selected.

Returns:

String

setAction

public void setAction(java.lang.String action)

Sets the Action, which should be processed if the Crumb is selected.

Parameters:

action - Action

getTitle

public java.lang.String getTitle()

Returns the Title

Returns:

The Title

setTitle

public void setTitle(java.lang.String title)

Sets the Title

Parameters:

title - The Title

setTooltip

public void setTooltip(java.lang.String tooltip)

Sets the tooltip text

Parameters:

tooltip - The Tooltip

getTooltip

public java.lang.String getTooltip()

Returns the tooltip

Returns:

The tooltip

setImageRef

public void setImageRef(java.lang.String ref)

Assigns the Crumb an Image from an ImageMap

Parameters:

ref - Rule of the ImageMap to match

getImageRef

public java.lang.String getImageRef()

Returns the assignment Rule

Returns:

String

setPermission

public void setPermission(Permission permission)

Sets a list with permission for the object. Permissions are separated by ';'

Parameters:

permission - Permission

setDisabled

public void setDisabled(boolean disabled)

Marks the crumb as disabled

Parameters:

disabled - true to disable the crumb

isDisabled

public boolean isDisabled()

Checks if the crumb is disabled

Returns:

returns true if the crumb is disabled

filter

public java.lang.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. If a null is returned than the filter of the enclosing CrumbControl should be used

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

setLocaleName

public void setLocaleName(java.lang.String locale)

Sets the Locale configuration for this element

Parameters:

locale - Locale Identifier or true|false

getLocaleName

public java.lang.String getLocaleName()

Gets the Local Setting for this element

Returns:

Locale Setting