com.cc.framework.ui.model
Interface ColumnComboBoxDesignModel

All Superinterfaces:

AccessControlled, ActionBehavior, AjaxSupport, ClientHandler, ColumnDesignModel, DesignModel, OptionListDesignModel

All Known Implementing Classes:

ColumnComboBoxDesignModelImp

public interface ColumnComboBoxDesignModel

extends ColumnDesignModel, OptionListDesignModel

Defines the visual Properties for the select Column

Version:

$Revision$

Author:

Harald Schulz

Method Summary

boolean	filter() Returns if the filter is activated (default=true).
int	getMaxLength() Returns the maximal number of input characters which can be inserted into the text field.
java.lang.String	getOptionsProperty() Returns the name of the property which returns the individual OptionListDataModel for each row of the list
java.lang.Object	getSharedOptions() Returns the OptionListDataModel that is shared among all rows of the list
int	getSize() Returns the number of visible characters for an input/text field.
java.lang.String	getTooltip() Retrieves the optional tooltip text
void	setFilter(boolean filter) Activates the HTML encoding (filter).
void	setMaxLength(int maxLength) Sets the maximum number of input characters to accept.
void	setOptionsProperty(java.lang.String property) Specifies the name of the property which returns the OptionListDataModel
void	setSharedOptions(java.lang.Object elements) Sets a option list that is shared among all rows of the list
void	setSize(int size) Sets the size of the input field.
void	setSize(java.lang.String size) Sets the size of the input field.
void	setTooltip(java.lang.String tooltip) Sets the optional tooltip text

Methods inherited from interface com.cc.framework.ui.model.ColumnDesignModel

addDesignRule, allowAjaxRendering, getAlignment, getAnchor, getAnchorProperty, getConverter, getDesignRules, getDisableProperty, getEditableProperty, getEnableProperty, getEnvironment, getHeader, getImageMap, getImageProperty, getJoinMode, getLinkName, getLinkNameProperty, getProperty, getRunAt, getStyle, getStyleClass, getStyleId, getTarget, getTargetProperty, getTitle, getTooltipProperty, getTransaction, getType, getWidth, isDisabled, isEditable, isSortable, setAlignment, setAlignment, setAnchor, setAnchorProperty, setConverter, setDisabled, setDisabled, setDisableProperty, setEditable, setEditable, setEditableProperty, setEnableProperty, setEnvironment, setFilter, setHeader, setImageMap, setImageProperty, setJoinMode, setJoinMode, setLinkName, setLinkNameProperty, setMaxLength, setPermission, setPermission, setProperty, setRunAt, setSortable, setStyle, setStyleClass, setStyleId, setTarget, setTargetProperty, setTitle, setTooltipProperty, setTransaction, setType, setWidth, 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

Methods inherited from interface com.cc.framework.ui.model.OptionListDesignModel

getEmpty, getImageMap, getKeyProperty, getLabelProperty, getProperty, getStyle, getStyleClass, getTooltipProperty, localize, setEmpty, setImageMap, setKeyProperty, setLabelProperty, setLocalize, setProperty, setStyle, setStyleClass, setTooltipProperty, showRoot, showRoot

Method Detail

setOptionsProperty

public void setOptionsProperty(java.lang.String property)

Specifies the name of the property which returns the OptionListDataModel

Parameters:

property - The name of the property

getOptionsProperty

public java.lang.String getOptionsProperty()

Returns the name of the property which returns the individual OptionListDataModel for each row of the list

Returns:

The name of the property

setSharedOptions

public void setSharedOptions(java.lang.Object elements)

Sets a option list that is shared among all rows of the list

Parameters:

elements - The Option elements

getSharedOptions

public java.lang.Object getSharedOptions()

Returns the OptionListDataModel that is shared among all rows of the list

Returns:

Option elements

getSize

public int getSize()

Returns the number of visible characters for an input/text field.

Returns:

Number of character positions to allocate

setSize

public void setSize(int size)

Sets the size of the input field.

Parameters:

size - The size of the input field.

setSize

public void setSize(java.lang.String size)

Sets the size of the input field.

Parameters:

size - The size of the input field.

getMaxLength

public int getMaxLength()

Returns the maximal number of input characters which can be inserted into the text field.

Specified by:

getMaxLength in interface ColumnDesignModel

Returns:

Maximum number of input characters to accept

setMaxLength

public void setMaxLength(int maxLength)

Sets the maximum number of input characters to accept.

Specified by:

setMaxLength in interface ColumnDesignModel

Parameters:

maxLength - The maximum number of input characters to accept.

setTooltip

public void setTooltip(java.lang.String tooltip)

Sets the optional tooltip text

Specified by:

setTooltip in interface ColumnDesignModel

Parameters:

tooltip - Tooltip

getTooltip

public java.lang.String getTooltip()

Retrieves the optional tooltip text

Specified by:

getTooltip in interface ColumnDesignModel

Returns:

tooltip text or null

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

Specified by:

filter in interface ColumnDesignModel

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.

Specified by:

setFilter in interface ColumnDesignModel

Parameters:

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