com.cc.framework.ui.model
Interface OptionListDesignModel

All Superinterfaces:

DesignModel

All Known Subinterfaces:

ColumnComboBoxDesignModel, ColumnSelectDesignModel

All Known Implementing Classes:

ColumnComboBoxDesignModelImp, ColumnSelectDesignModelImp, OptionListDesignModelImp

public interface OptionListDesignModel

extends DesignModel

Designmodel for the option list

Since:

1.0

Version:

$Revision: 1.13 $

Author:

Harald Schulz

Method Summary

boolean	filter() Returns if the filter is activated (default=true).
java.lang.String	getEmpty() Returns the label of an additional empty-entry
ImageMap	getImageMap() Returns the associated ImageMap
java.lang.String	getKeyProperty() Returns the name of the property which returns the key of the option.
java.lang.String	getLabelProperty() Returns the name of the property which supplies the display text of the option.
int	getMaxLength() Returns the maximum number of characters that are displayed for each option element.
java.lang.String	getProperty() Returns the name of the property using which the Java-Bean is to be accessed.
java.lang.String	getStyle() Returns the HTML-style that can be directly specified with this attribute.
java.lang.String	getStyleClass() Returns the HTML-class attribute that can be specified with this attribute
java.lang.String	getTooltipProperty() Returns the name of the property which supplies the tooltip text of the option.
boolean	localize() If this flag is set to true the framework interprets all labels as resource identifiers and localize them.
void	setEmpty(java.lang.String empty) Sets the label of an additional empty-entry
void	setFilter(boolean filter) Activates the HTML encoding (filter).
void	setImageMap(ImageMap map) Specifies the image map.
void	setKeyProperty(java.lang.String property) Sets the name of the property which returns the key of the option.
void	setLabelProperty(java.lang.String property) Sets the name of the property which supplies the display text of the option.
void	setLocalize(boolean localize) If this flag is set to true the framework interprets all labels as resource identifiers and localize them.
void	setMaxLength(int max) Sets the maximum number of characters that are displayed for each option element.
void	setProperty(java.lang.String property) Sets the name of the property which holds the data for the column
void	setStyle(java.lang.String style) Sets the CSS styles to be applied to this column.
void	setStyleClass(java.lang.String styleClass) Sets the CSS stylesheet class
void	setTooltipProperty(java.lang.String property) Sets the name of the property which supplies the tooltip text of the option.
boolean	showRoot() Returns if the root element should be displayed (for TreeDataModel options)
void	showRoot(boolean show) Specifies whether the root of the tree element should be displayed (for TreeDataModel options).

Method Detail

getEmpty

public java.lang.String getEmpty()

Returns the label of an additional empty-entry

Returns:

Label for the additional empty-entry

setEmpty

public void setEmpty(java.lang.String empty)

Sets the label of an additional empty-entry

Parameters:

empty - Label for the additional empty-entry

getKeyProperty

public java.lang.String getKeyProperty()

Returns the name of the property which returns the key of the option.

Returns:

Name of the property

setKeyProperty

public void setKeyProperty(java.lang.String property)

Sets the name of the property which returns the key of the option.

Parameters:

property - Name of the property

getLabelProperty

public java.lang.String getLabelProperty()

Returns the name of the property which supplies the display text of the option.

Returns:

Name of the property

getTooltipProperty

public java.lang.String getTooltipProperty()

Returns the name of the property which supplies the tooltip text of the option.

Returns:

Name of the property

setLabelProperty

public void setLabelProperty(java.lang.String property)

Sets the name of the property which supplies the display text of the option.

Parameters:

property - Name of the property

setTooltipProperty

public void setTooltipProperty(java.lang.String property)

Sets the name of the property which supplies the tooltip text of the option.

Parameters:

property - Name of the property

getProperty

public java.lang.String getProperty()

Returns the name of the property using which the Java-Bean is to be accessed.

Returns:

Name of the property

setProperty

public void setProperty(java.lang.String property)

Sets the name of the property which holds the data for the column

Parameters:

property - The name of the property.

getStyle

public java.lang.String getStyle()

Returns the HTML-style that can be directly specified with this attribute.

Returns:

The HTML-style

setStyle

public void setStyle(java.lang.String style)

Sets the CSS styles to be applied to this column.

Parameters:

style - The CSS styles for this column.

getStyleClass

public java.lang.String getStyleClass()

Returns the HTML-class attribute that can be specified with this attribute

Returns:

The HTML-class

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Sets the CSS stylesheet class

Parameters:

styleClass - The CSS stylesheet class

getMaxLength

public int getMaxLength()

Returns the maximum number of characters that are displayed for each option element.

Returns:

Maximum number of characters to display

setMaxLength

public void setMaxLength(int max)

Sets the maximum number of characters that are displayed for each option element.

Parameters:

max - Maximum number of characters to display

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

setLocalize

public void setLocalize(boolean localize)

If this flag is set to true the framework interprets all labels as resource identifiers and localize them. If the flag is set to false the labels are treated as string literals without localization.

Parameters:

localize - Localization setting for the option list

localize

public boolean localize()

If this flag is set to true the framework interprets all labels as resource identifiers and localize them. If the flag is set to false the labels are treated as string literals without localization.

Returns:

true if all labels should be localized

setImageMap

public void setImageMap(ImageMap map)

Specifies the image map.

Parameters:

map - ImageMap

getImageMap

public ImageMap getImageMap()

Returns the associated ImageMap

Returns:

ImageMap

showRoot

public boolean showRoot()

Returns if the root element should be displayed (for TreeDataModel options)

Returns:

boolean true if the root element should be displayed; false otherwise

showRoot

public void showRoot(boolean show)

Specifies whether the root of the tree element should be displayed (for TreeDataModel options).

Parameters:

show - true if the root element should be displayed