com.cc.framework.ui.model.imp
Class TabsetDesignModelImp

java.lang.Object
  com.cc.framework.ui.model.imp.ClientHandlerImp
      com.cc.framework.ui.model.imp.ControlDesignModelImp
          com.cc.framework.ui.model.imp.TabsetDesignModelImp

All Implemented Interfaces:

AccessControlled, ActionBehavior, AjaxSupport, ClientHandler, ControlDesignModel, DesignModel, java.io.Serializable, TabsetDesignModel

public class TabsetDesignModelImp

extends ControlDesignModelImp

implements TabsetDesignModel

Designmodel for the TabSetControl

Since:

1.0

Version:

$Revision: 1.17 $

Author:

Harald Schulz

See Also:

Serialized Form

Field Summary

private Color	bgcolor The background color of the TabSet
private boolean	filter Specifies if all String should be converted into there HTML representation
private ImageMap	imagemap The ImageMap which can be used to paint icons in front of the labels.
private int	labelLength The length of the labels.
private int	maxVisible The number of visible Tabs.
private boolean	overlapping true when the tabs should be displayed in overlapping mode
private static long	serialVersionUID Serial Version UID
private boolean	stacked This flag indicates if stacked display mode for the control is enabled
private java.util.ArrayList	tabs Buffer for the Tabs of the Tabset

Fields inherited from class com.cc.framework.ui.model.imp.ControlDesignModelImp

Fields inherited from class com.cc.framework.ui.model.imp.ClientHandlerImp

Constructor Summary

TabsetDesignModelImp()
Constructor for TabsetDesignModelImp

Method Summary

TabsetDesignModel	addTab(TabDesignModel newTab) 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 imagemap) 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 class com.cc.framework.ui.model.imp.ControlDesignModelImp

addDesignRule, enableAjax, getAction, getBorder, getDesignRules, getHeight, getHelp, getId, getLocaleName, getName, getPermission, getProperty, getRunAt, getStyle, getStyleClass, getStyleId, getSummary, getTabIndex, getTooltip, getTransaction, getWidth, hasShadow, isAjaxEnabled, 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, show

Methods inherited from class com.cc.framework.ui.model.imp.ClientHandlerImp

evaluate, getHandler, getHandlers, setHandler

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Field Detail

serialVersionUID

private static final long serialVersionUID

Serial Version UID

See Also:

Constant Field Values

tabs

private java.util.ArrayList tabs

Buffer for the Tabs of the Tabset

maxVisible

private int maxVisible

The number of visible Tabs. If more Tabs exists you can scroll through the Tabs with the previous or next button.

stacked

private boolean stacked

This flag indicates if stacked display mode for the control is enabled

labelLength

private int labelLength

The length of the labels. If a label exceed this length it will be cut.

imagemap

private ImageMap imagemap

The ImageMap which can be used to paint icons in front of the labels.

bgcolor

private Color bgcolor

The background color of the TabSet

filter

private boolean filter

Specifies if all String should be converted into there HTML representation

overlapping

private boolean overlapping

true when the tabs should be displayed in overlapping mode

Constructor Detail

TabsetDesignModelImp

public TabsetDesignModelImp()

Constructor for TabsetDesignModelImp

Method Detail

addTab

public TabsetDesignModel addTab(TabDesignModel newTab)

Description copied from interface: TabsetDesignModel

Adds a tab page to the Tabset

Specified by:

addTab in interface TabsetDesignModel

Parameters:

newTab - TabsetDesignModel

Returns:

TabsetDesignModel

See Also:

TabsetDesignModel.addTab(TabDesignModel)

removeTab

public void removeTab(TabDesignModel tab)

Description copied from interface: TabsetDesignModel

Removes a tab page from the Tabset

Specified by:

removeTab in interface TabsetDesignModel

Parameters:

tab - Tab to be removed

See Also:

TabsetDesignModel.removeTab(TabDesignModel)

getTabs

public TabDesignModel[] getTabs()

Description copied from interface: TabsetDesignModel

Returns an Array with all tab pages

Specified by:

getTabs in interface TabsetDesignModel

Returns:

TabDesignModel

See Also:

TabsetDesignModel.getTabs()

size

public int size()

Description copied from interface: TabsetDesignModel

Returns the total Number of tab pages

Specified by:

size in interface TabsetDesignModel

Returns:

integer

See Also:

TabsetDesignModel.size()

getMaxVisible

public int getMaxVisible()

Description copied from interface: TabsetDesignModel

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

Specified by:

getMaxVisible in interface TabsetDesignModel

Returns:

integer

See Also:

TabsetDesignModel.getMaxVisible()

setMaxVisible

public void setMaxVisible(int max)

Description copied from interface: TabsetDesignModel

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

Specified by:

setMaxVisible in interface TabsetDesignModel

Parameters:

max - Number of visible tab pages.

See Also:

TabsetDesignModel.setMaxVisible(int)

getBgColor

public Color getBgColor()

Description copied from interface: TabsetDesignModel

Returns the Background Color

Specified by:

getBgColor in interface TabsetDesignModel

Returns:

Color

See Also:

TabsetDesignModel.getBgColor()

setBgColor

public void setBgColor(Color bgcolor)

Description copied from interface: TabsetDesignModel

Sets the Background Color

Specified by:

setBgColor in interface TabsetDesignModel

Parameters:

bgcolor - Background Color

See Also:

TabsetDesignModel.setBgColor(com.cc.framework.ui.Color)

getImageMap

public ImageMap getImageMap()

Description copied from interface: TabsetDesignModel

Returns the image map

Specified by:

getImageMap in interface TabsetDesignModel

Returns:

ImageMap

See Also:

TabsetDesignModel.getImageMap()

setImageMap

public void setImageMap(ImageMap imagemap)

Description copied from interface: TabsetDesignModel

Sets the image map for the TabSet

Specified by:

setImageMap in interface TabsetDesignModel

Parameters:

imagemap - ImageMap

See Also:

TabsetDesignModel.setImageMap(com.cc.framework.ui.ImageMap)

getLabelLength

public int getLabelLength()

Description copied from interface: TabsetDesignModel

Returns the maximal length for labels

Specified by:

getLabelLength in interface TabsetDesignModel

Returns:

integer

See Also:

TabsetDesignModel.getLabelLength()

setLabelLength

public void setLabelLength(int length)

Description copied from interface: TabsetDesignModel

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.

Specified by:

setLabelLength in interface TabsetDesignModel

Parameters:

length - LabelLength

See Also:

TabsetDesignModel.setLabelLength(int)

filter

public boolean filter()

Description copied from interface: TabsetDesignModel

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

Specified by:

filter in interface TabsetDesignModel

Returns:

true if string will be HTML encoded; false otherwise

See Also:

TabsetDesignModel.filter()

setFilter

public void setFilter(boolean filter)

Description copied from interface: TabsetDesignModel

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.

Specified by:

setFilter in interface TabsetDesignModel

Parameters:

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

See Also:

TabsetDesignModel.setFilter(boolean)

isOverlapping

public boolean isOverlapping()

Specified by:

isOverlapping in interface TabsetDesignModel

Returns:

returns true when the tabs should be displayed in overlapping mode

See Also:

TabsetDesignModel.isOverlapping()

setOverlapping

public void setOverlapping(boolean overlapping)

Description copied from interface: TabsetDesignModel

Sets the tabs of the Tabset to overlapping or not overlapping

Specified by:

setOverlapping in interface TabsetDesignModel

Parameters:

overlapping - mode

See Also:

TabsetDesignModel.setOverlapping(boolean)

isStacked

public boolean isStacked()

Specified by:

isStacked in interface TabsetDesignModel

Returns:

returns true when stacked display mode is enabled

See Also:

TabsetDesignModel.isStacked()

setStacked

public void setStacked(boolean stacked)

Description copied from interface: TabsetDesignModel

Sets the control in stacked display mode.

Specified by:

setStacked in interface TabsetDesignModel

Parameters:

stacked - true to enable stacked mode

See Also:

TabsetDesignModel.setStacked(boolean)