com.cc.framework.ui.model
Interface TextListDesignModel

All Superinterfaces:

AccessControlled, ActionBehavior, AjaxSupport, ClientHandler, ControlDesignModel, DesignModel

All Known Implementing Classes:

TextListDesignModelImp

public interface TextListDesignModel

extends ControlDesignModel

Designmodel for textlist fields.

The interface only defines getter methods for read only access.

Since:

1.0

Version:

$Revision: 1.5 $

Author:

Harald Schulz

Method Summary

boolean	filter() Returns if the filter is activated (default=true).
Converter	getConverter() Returns the the Converter that should be used to convert Java Objects into their localized String representation.
int	getMaxLength() Returns the maximal number of input characters which can be inserted into the text field.
int	getRows() Returns the number of visible rows in the list element
int	getSize() Returns the number of visible characters for an input/text field.
SortOrder	getSortOrder() Retrieves the sort order of the control
java.lang.String	getTooltip() Retrieves the optional tooltip text
void	setConverter(Converter converter) Sets the Converter that should be used to convert Java Objects into their localized String representation.
void	setFilter(boolean filter) Activates the HTML encoding (filter).
void	setMaxLength(int maxLength) Sets the maximum number of input characters to accept.
void	setRows(int rows) Sets the number of rows the list element will show
void	setSize(int size) Sets the size of the input field.
void	setSortOrder(SortOrder sortOrder) Specifies the sort order: none = no sort order asc = ascending sort order desc = descending sort order
void	setTooltip(java.lang.String tooltip) Sets the optional tooltip text

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, 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, 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

Method Detail

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.

getMaxLength

public int getMaxLength()

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

Returns:

Maximum number of input characters to accept

setMaxLength

public void setMaxLength(int maxLength)

Sets the maximum number of input characters to accept.

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 ControlDesignModel

Parameters:

tooltip - Tooltip

getTooltip

public java.lang.String getTooltip()

Retrieves the optional tooltip text

Specified by:

getTooltip in interface ControlDesignModel

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

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

getConverter

public Converter getConverter()

Returns the the Converter that should be used to convert Java Objects into their localized String representation. If no converter is specified the framework will use a default Converter that matches the beans data type

Returns:

Converter or null

setConverter

public void setConverter(Converter converter)

Sets the Converter that should be used to convert Java Objects into their localized String representation. If no converter is specified the framework will use a default Converter that matches the beans data type.

Parameters:

converter - Converters instance

getRows

public int getRows()

Returns the number of visible rows in the list element

Returns:

Number of rows

setRows

public void setRows(int rows)

Sets the number of rows the list element will show

Parameters:

rows - The number of rows

setSortOrder

public void setSortOrder(SortOrder sortOrder)

Specifies the sort order:

• none = no sort order
• asc = ascending sort order
• desc = descending sort order

Parameters:

sortOrder - The sort order of the control

getSortOrder

public SortOrder getSortOrder()

Retrieves the sort order of the control

Returns:

the sort order