com.cc.framework.ui.painter.html
Interface OptionItem

All Known Subinterfaces:

OptionsIterator

All Known Implementing Classes:

HtmlSwapSelectPainter.AvailableOptionsIterator, HtmlSwapSelectPainter.OptionItemImpl, HtmlSwapSelectPainter.OverallOptionsIterator, HtmlTreeSwapSelectPainter.AvailableOptionsIterator, HtmlTreeSwapSelectPainter.OptionItemImpl, HtmlTreeSwapSelectPainter.OverallOptionsIterator, OptionsHelp.IterBase

public interface OptionItem

Interface for option items

Version:

$Revision: 1.3 $

Author:

Harald Schulz

Method Summary

boolean	filter() Returns if the filter is activated (default=true).
ImageModel	getImage() Returns the image for the current option element.
int	getIndent() Gets an optional indentiation level of the current element.
java.lang.Object	getKey() Gets the key of the current iteration element
java.lang.Object	getLabel() Returns the label of the current element
int	getMaxLength() Returns the maximum number of characters that are displayed for each option element.
java.lang.Object	getProperty(java.lang.String propertyName) Returns the value for the given property on the current iteration element
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.Object	getTooltip() Returns the tooltip for the current element
boolean	localize() If this flag is set to true the framework interprets all labels as resource identifiers and localize them.

Method Detail

getKey

public java.lang.Object getKey()

Gets the key of the current iteration element

Returns:

Key

getLabel

public java.lang.Object getLabel()

Returns the label of the current element

Returns:

Label

getTooltip

public java.lang.Object getTooltip()

Returns the tooltip for the current element

Returns:

String or null

getIndent

public int getIndent()

Gets an optional indentiation level of the current element. This is used when iterating over a tree structure

Returns:

indentation level

getMaxLength

public int getMaxLength()

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

Returns:

Maximum number of characters to display

getStyle

public java.lang.String getStyle()

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

Returns:

The HTML-style

getStyleClass

public java.lang.String getStyleClass()

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

Returns:

The HTML-class

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

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 lables are treated as string literals without localization.

Returns:

true if all labels should be localized

getImage

public ImageModel getImage()

Returns the image for the current option element.

Returns:

Option Image or null

getProperty

public java.lang.Object getProperty(java.lang.String propertyName)

Returns the value for the given property on the current iteration element

Parameters:

propertyName - the property name

Returns:

property value