com.cc.framework.ui.model
Interface PanelContentDesignModel

All Superinterfaces:

AccessControlled, DesignModel

All Known Implementing Classes:

PanelContentDesignModelImp

public interface PanelContentDesignModel

extends DesignModel, AccessControlled

Design model for panels

Since:

1.0

Version:

$Revision: 1.11 $

Author:

Harald Schulz

Method Summary

void	addItem(PanelItemDesignModel item) Adds a panel item
boolean	filter() Returns if the filter is activated (default=true).
java.lang.String	getAction() Returns the action
ImageModel	getImage() Returns the image for the content body
PanelItemDesignModel[]	getItems() Returns a collection with the items
java.lang.String	getLocaleName() Gets the Local Setting for this element
java.lang.String	getMore() Return the text which should be displayed if there is a "other items" link.
java.lang.String	getTitle() Returns the title
java.lang.String	getTooltip() Returns the Tooltip
void	removeItem(PanelItemDesignModel item) Removes a panel item
void	setAction(java.lang.String action) Sets the action which should be processed if the user clicks on the "more link".
void	setFilter(boolean filter) Activates the HTML encoding (filter).
void	setImage(ImageModel img) Sets an image for the content body
void	setLocaleName(java.lang.String locale) Sets the Locale configuration for this element
void	setMore(java.lang.String more) Return the text which should be displayed if there are more items as displayed
void	setPermission(Permission permission) Sets a list with permissions to access this object.
void	setTitle(java.lang.String title) Sets the title
void	setTooltip(java.lang.String tooltip) Sets the Tooltip
int	size() Returns the number of items

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

getPermission, show

Method Detail

addItem

public void addItem(PanelItemDesignModel item)

Adds a panel item

Parameters:

item - PanelItemDesignModel

removeItem

public void removeItem(PanelItemDesignModel item)

Removes a panel item

Parameters:

item - PanelItemDesignModel

getImage

public ImageModel getImage()

Returns the image for the content body

Returns:

ImageModel

getItems

public PanelItemDesignModel[] getItems()

Returns a collection with the items

Returns:

PanelItemDesignModel

getMore

public java.lang.String getMore()

Return the text which should be displayed if there is a "other items" link. This means that not all items are display in the panel at the same time

Returns:

String

setMore

public void setMore(java.lang.String more)

Return the text which should be displayed if there are more items as displayed

Parameters:

more - The hint to be display if there are more items

getTitle

public java.lang.String getTitle()

Returns the title

Returns:

String

setImage

public void setImage(ImageModel img)

Sets an image for the content body

Parameters:

img - ImageModel

setTitle

public void setTitle(java.lang.String title)

Sets the title

Parameters:

title - The title

size

public int size()

Returns the number of items

Returns:

The number of items

setAction

public void setAction(java.lang.String action)

Sets the action which should be processed if the user clicks on the "more link".

Parameters:

action - The action to process

getAction

public java.lang.String getAction()

Returns the action

Returns:

The action

setPermission

public void setPermission(Permission permission)

Sets a list with permissions to access this object. The permission are separated by ';'.

Parameters:

permission - Permission

setTooltip

public void setTooltip(java.lang.String tooltip)

Sets the Tooltip

Parameters:

tooltip - Tooltip

getTooltip

public java.lang.String getTooltip()

Returns the Tooltip

Returns:

String

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. 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