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

java.lang.Object
  com.cc.framework.ui.model.imp.OptionListDesignModelImp

All Implemented Interfaces:

DesignModel, OptionListDesignModel, java.io.Serializable

public class OptionListDesignModelImp

extends java.lang.Object

implements OptionListDesignModel, java.io.Serializable

Designmodel for Optionslists

Since:

1.0

Version:

$Revision: 1.18 $

Author:

Harald Schulz

See Also:

Serialized Form

Field Summary

private java.lang.String	empty An optional text to prompt the user for selecting an option of the list.
private boolean	filter Specifies if all String should be converted into there HTML representation
private ImageMap	imageMap The Image Map
private java.lang.String	keyProperty The property for the key
private java.lang.String	labelProperty The property for the label
private boolean	localize Specifies if all String should be treated as Resource Identifiers and must be localized
private int	maxLength The maximum number of characters that are displayed for each option element.
private java.lang.String	property Name of the property for the options list
private static long	serialVersionUID Serial Version UID
private boolean	showRoot Shows or hides the root of a TreeNodeDatamodel option list
private java.lang.String	style CSS styles to be applied to this HTML element
private java.lang.String	styleClass CSS stylesheet class to be applied to this HTML element
private java.lang.String	tooltipProperty The property for the tooltip

Constructor Summary

OptionListDesignModelImp()
Constructor for OptionListDesignModelImp

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 keyProperty) Sets the name of the property which returns the key of the option.
void	setLabelProperty(java.lang.String labelProperty) 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 tooltipProperty) 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).

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

Serial Version UID

See Also:

Constant Field Values

property

private java.lang.String property

Name of the property for the options list

keyProperty

private java.lang.String keyProperty

The property for the key

labelProperty

private java.lang.String labelProperty

The property for the label

tooltipProperty

private java.lang.String tooltipProperty

The property for the tooltip

maxLength

private int maxLength

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

empty

private java.lang.String empty

An optional text to prompt the user for selecting an option of the list. Something like "<please select>"

style

private java.lang.String style

CSS styles to be applied to this HTML element

styleClass

private java.lang.String styleClass

CSS stylesheet class to be applied to this HTML element

showRoot

private boolean showRoot

Shows or hides the root of a TreeNodeDatamodel option list

filter

private boolean filter

Specifies if all String should be converted into there HTML representation

localize

private boolean localize

Specifies if all String should be treated as Resource Identifiers and must be localized

imageMap

private ImageMap imageMap

The Image Map

Constructor Detail

OptionListDesignModelImp

public OptionListDesignModelImp()

Constructor for OptionListDesignModelImp

Method Detail

getEmpty

public java.lang.String getEmpty()

Description copied from interface: OptionListDesignModel

Returns the label of an additional empty-entry

Specified by:

getEmpty in interface OptionListDesignModel

Returns:

Label for the additional empty-entry

See Also:

OptionListDesignModel.getEmpty()

getKeyProperty

public java.lang.String getKeyProperty()

Description copied from interface: OptionListDesignModel

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

Specified by:

getKeyProperty in interface OptionListDesignModel

Returns:

Name of the property

See Also:

OptionListDesignModel.getKeyProperty()

getLabelProperty

public java.lang.String getLabelProperty()

Description copied from interface: OptionListDesignModel

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

Specified by:

getLabelProperty in interface OptionListDesignModel

Returns:

Name of the property

See Also:

OptionListDesignModel.getLabelProperty()

getTooltipProperty

public java.lang.String getTooltipProperty()

Description copied from interface: OptionListDesignModel

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

Specified by:

getTooltipProperty in interface OptionListDesignModel

Returns:

Name of the property

See Also:

OptionListDesignModel.getTooltipProperty()

getProperty

public java.lang.String getProperty()

Description copied from interface: OptionListDesignModel

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

Specified by:

getProperty in interface OptionListDesignModel

Returns:

Name of the property

See Also:

OptionListDesignModel.getProperty()

getStyle

public java.lang.String getStyle()

Description copied from interface: OptionListDesignModel

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

Specified by:

getStyle in interface OptionListDesignModel

Returns:

The HTML-style

See Also:

OptionListDesignModel.getStyle()

getStyleClass

public java.lang.String getStyleClass()

Description copied from interface: OptionListDesignModel

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

Specified by:

getStyleClass in interface OptionListDesignModel

Returns:

The HTML-class

See Also:

OptionListDesignModel.getStyleClass()

setEmpty

public void setEmpty(java.lang.String empty)

Description copied from interface: OptionListDesignModel

Sets the label of an additional empty-entry

Specified by:

setEmpty in interface OptionListDesignModel

Parameters:

empty - Label for the additional empty-entry

See Also:

OptionListDesignModel.setEmpty(java.lang.String)

setKeyProperty

public void setKeyProperty(java.lang.String keyProperty)

Description copied from interface: OptionListDesignModel

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

Specified by:

setKeyProperty in interface OptionListDesignModel

Parameters:

keyProperty - Name of the property

See Also:

OptionListDesignModel.setKeyProperty(java.lang.String)

setLabelProperty

public void setLabelProperty(java.lang.String labelProperty)

Description copied from interface: OptionListDesignModel

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

Specified by:

setLabelProperty in interface OptionListDesignModel

Parameters:

labelProperty - Name of the property

See Also:

OptionListDesignModel.setLabelProperty(java.lang.String)

setTooltipProperty

public void setTooltipProperty(java.lang.String tooltipProperty)

Description copied from interface: OptionListDesignModel

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

Specified by:

setTooltipProperty in interface OptionListDesignModel

Parameters:

tooltipProperty - Name of the property

See Also:

OptionListDesignModel.setTooltipProperty(java.lang.String)

setProperty

public void setProperty(java.lang.String property)

Description copied from interface: OptionListDesignModel

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

Specified by:

setProperty in interface OptionListDesignModel

Parameters:

property - The name of the property.

See Also:

OptionListDesignModel.setProperty(java.lang.String)

setStyle

public void setStyle(java.lang.String style)

Description copied from interface: OptionListDesignModel

Sets the CSS styles to be applied to this column.

Specified by:

setStyle in interface OptionListDesignModel

Parameters:

style - The CSS styles for this column.

See Also:

OptionListDesignModel.setStyle(java.lang.String)

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Description copied from interface: OptionListDesignModel

Sets the CSS stylesheet class

Specified by:

setStyleClass in interface OptionListDesignModel

Parameters:

styleClass - The CSS stylesheet class

See Also:

OptionListDesignModel.setStyleClass(java.lang.String)

getMaxLength

public int getMaxLength()

Description copied from interface: OptionListDesignModel

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

Specified by:

getMaxLength in interface OptionListDesignModel

Returns:

Maximum number of characters to display

See Also:

OptionListDesignModel.getMaxLength()

setMaxLength

public void setMaxLength(int max)

Description copied from interface: OptionListDesignModel

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

Specified by:

setMaxLength in interface OptionListDesignModel

Parameters:

max - Maximum number of characters to display

See Also:

OptionListDesignModel.setMaxLength(int)

filter

public boolean filter()

Description copied from interface: OptionListDesignModel

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 OptionListDesignModel

Returns:

true if string will be HTML encoded; false otherwise

See Also:

OptionListDesignModel.filter()

setFilter

public void setFilter(boolean filter)

Description copied from interface: OptionListDesignModel

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 OptionListDesignModel

Parameters:

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

See Also:

OptionListDesignModel.setFilter(boolean)

localize

public boolean localize()

Description copied from interface: OptionListDesignModel

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.

Specified by:

localize in interface OptionListDesignModel

Returns:

true if all labels should be localized

See Also:

OptionListDesignModel.localize()

setLocalize

public void setLocalize(boolean localize)

Description copied from interface: OptionListDesignModel

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.

Specified by:

setLocalize in interface OptionListDesignModel

Parameters:

localize - Localization setting for the option list

See Also:

OptionListDesignModel.setLocalize(boolean)

setImageMap

public void setImageMap(ImageMap map)

Description copied from interface: OptionListDesignModel

Specifies the image map.

Specified by:

setImageMap in interface OptionListDesignModel

Parameters:

map - ImageMap

See Also:

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

getImageMap

public ImageMap getImageMap()

Description copied from interface: OptionListDesignModel

Returns the associated ImageMap

Specified by:

getImageMap in interface OptionListDesignModel

Returns:

ImageMap

See Also:

OptionListDesignModel.getImageMap()

showRoot

public boolean showRoot()

Description copied from interface: OptionListDesignModel

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

Specified by:

showRoot in interface OptionListDesignModel

Returns:

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

See Also:

OptionListDesignModel.showRoot()

showRoot

public void showRoot(boolean show)

Description copied from interface: OptionListDesignModel

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

Specified by:

showRoot in interface OptionListDesignModel

Parameters:

show - true if the root element should be displayed

See Also:

OptionListDesignModel.showRoot(boolean)