com.cc.framework.ui.model
Interface TabsetDesignModel

All Superinterfaces:

AccessControlled, ActionBehavior, AjaxSupport, ClientHandler, ControlDesignModel, DesignModel

All Known Implementing Classes:

TabsetDesignModelImp

public interface TabsetDesignModel

extends ControlDesignModel

DesignModel for a Tabset

Since:

1.0

Version:

$Revision: 1.12 $

Author:

Harald Schulz

Method Summary

TabsetDesignModel	addTab(TabDesignModel tab) Adds a tab page to the Tabset
boolean	filter() Returns if the filter is activated (default=true).
Color	getBgColor() Returns the Background Color
ImageMap	getImageMap() Returns the image map
int	getLabelLength() Returns the maximal length for labels
int	getMaxVisible() Returns the number of visible tab pages.
TabDesignModel[]	getTabs() Returns an Array with all tab pages
boolean	isOverlapping()
boolean	isStacked()
void	removeTab(TabDesignModel tab) Removes a tab page from the Tabset
void	setBgColor(Color bgcolor) Sets the Background Color
void	setFilter(boolean filter) Activates the HTML encoding (filter).
void	setImageMap(ImageMap map) Sets the image map for the TabSet
void	setLabelLength(int length) Sets the maximal length for labels shown on a tab page.
void	setMaxVisible(int max) Sets the number of visible tab pages.
void	setOverlapping(boolean overlapping) Sets the tabs of the Tabset to overlapping or not overlapping
void	setStacked(boolean stacked) Sets the control in stacked display mode.
int	size() Returns the total Number of tab pages

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

addTab

public TabsetDesignModel addTab(TabDesignModel tab)

Adds a tab page to the Tabset

Parameters:

tab - TabsetDesignModel

Returns:

TabsetDesignModel

removeTab

public void removeTab(TabDesignModel tab)

Removes a tab page from the Tabset

Parameters:

tab - Tab to be removed

getTabs

public TabDesignModel[] getTabs()

Returns an Array with all tab pages

Returns:

TabDesignModel

size

public int size()

Returns the total Number of tab pages

Returns:

integer

getMaxVisible

public int getMaxVisible()

Returns the number of visible tab pages. A value of -1 means that all pages are visible

Returns:

integer

setMaxVisible

public void setMaxVisible(int max)

Sets the number of visible tab pages. A value of -1 means that all pages are visible.

Parameters:

max - Number of visible tab pages.

isStacked

public boolean isStacked()

Returns:

returns true when stacked display mode is enabled

setStacked

public void setStacked(boolean stacked)

Sets the control in stacked display mode.

Parameters:

stacked - true to enable stacked mode

setBgColor

public void setBgColor(Color bgcolor)

Sets the Background Color

Parameters:

bgcolor - Background Color

getBgColor

public Color getBgColor()

Returns the Background Color

Returns:

Color

setImageMap

public void setImageMap(ImageMap map)

Sets the image map for the TabSet

Parameters:

map - ImageMap

getImageMap

public ImageMap getImageMap()

Returns the image map

Returns:

ImageMap

setLabelLength

public void setLabelLength(int length)

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

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

isOverlapping

public boolean isOverlapping()

Returns:

returns true when the tabs should be displayed in overlapping mode

setOverlapping

public void setOverlapping(boolean overlapping)

Sets the tabs of the Tabset to overlapping or not overlapping

Parameters:

overlapping - mode