com.cc.framework.ui.model
Interface FormLabelDesignModel

All Superinterfaces:

ClientHandler, DesignModel

All Known Implementing Classes:

FormLabelDesignModelImp

public interface FormLabelDesignModel

extends DesignModel, ClientHandler

Design Model for a Column Header

Version:

$Revision: 1.8 $

Author:

Harald Schulz

Method Summary

boolean	filter() Returns if the filter is activated (default=true).
java.lang.String	getAccessKey() The ACCESSKEY attribute can be used to specify a shortcut key for the <LABEL> (activated by pressing 'alt' and the ACCESSKEY together).
AlignmentType	getAlignment() Returns the alignment for the label
java.lang.String	getImageRef() Returns the assignment Rule
java.lang.String	getLocaleName() Gets the Local Setting for this element
int	getMaxLength() Returns the maximal number of input characters which can be inserted into the text field.
java.lang.Boolean	getNowrap() Returns the value of the nowrap attribute.
java.lang.String	getPrefix() Retrieves the optional label prefix in plain HTML
java.lang.String	getStyle() Returns the CSS styles for this label.
java.lang.String	getStyleClass() Returns the CSS stylesheet class
java.lang.String	getStyleId() Returns the Identifier assigned to this label.
java.lang.String	getSuffix() Retrieves the optional label suffix in plain HTML
java.lang.String	getText() Returns the labels text
java.lang.String	getTooltip() Returns the static tooltip text
java.lang.String	getWidth() Returns the width of the label
boolean	isBodyInclude() Returns if the header text was set within the body (true) or as an attribute (false)
void	setAccessKey(java.lang.String accessKey) The ACCESSKEY attribute can be used to specify a shortcut key for the <LABEL> (activated by pressing 'alt' and the ACCESSKEY together).
void	setAlignment(AlignmentType alignment) Sets the alignment for the label
void	setBodyInclude(boolean include) Sets if the header text is set within the body (true)
void	setFilter(boolean filter) Activates the HTML encoding (filter).
void	setImageRef(java.lang.String ref) Assigns an Image from an ImageMap
void	setLocaleName(java.lang.String locale) Sets the Locale configuration for this element
void	setMaxLength(int max) Sets the maximal number of input characters which can be inserted into the text field.
void	setNowrap(java.lang.Boolean nowrap) Sets the value of the nowrap attribute
void	setPrefix(java.lang.String prefix) Specifies the label prefix in plain HTML
void	setStyle(java.lang.String style) Sets the CSS styles to be applied to this label.
void	setStyleClass(java.lang.String styleClass) Sets the CSS stylesheet class
void	setStyleId(java.lang.String id) Identifier to be assigned to this label.
void	setSuffix(java.lang.String suffix) Specifies the label suffix in plain HTML
void	setText(java.lang.String text) Sets the labels text
void	setTooltip(java.lang.String tooltip) Sets the static tooltip text.
void	setWidth(java.lang.String width) Sets the width of the label

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

getHandler, getHandlers, setHandler

Method Detail

getText

public java.lang.String getText()

Returns the labels text

Returns:

string

setText

public void setText(java.lang.String text)

Sets the labels text

Parameters:

text - The label text

getPrefix

public java.lang.String getPrefix()

Retrieves the optional label prefix in plain HTML

Returns:

Prefix (plain HTML) or null

setPrefix

public void setPrefix(java.lang.String prefix)

Specifies the label prefix in plain HTML

Parameters:

prefix - The label prefix

getSuffix

public java.lang.String getSuffix()

Retrieves the optional label suffix in plain HTML

Returns:

Suffix (plain HTML) or null

setSuffix

public void setSuffix(java.lang.String suffix)

Specifies the label suffix in plain HTML

Parameters:

suffix - The label suffix

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

setAccessKey

public void setAccessKey(java.lang.String accessKey)

The ACCESSKEY attribute can be used to specify a shortcut key for the <LABEL> (activated by pressing 'alt' and the ACCESSKEY together).

Parameters:

accessKey - The Access Key

getAccessKey

public java.lang.String getAccessKey()

The ACCESSKEY attribute can be used to specify a shortcut key for the <LABEL> (activated by pressing 'alt' and the ACCESSKEY together).

Returns:

The Access Key

setTooltip

public void setTooltip(java.lang.String tooltip)

Sets the static tooltip text.

Parameters:

tooltip - Tooltip text

getTooltip

public java.lang.String getTooltip()

Returns the static tooltip text

Returns:

String

setStyleId

public void setStyleId(java.lang.String id)

Identifier to be assigned to this label.

Parameters:

id - The identifier to be assigned to this label.

getStyleId

public java.lang.String getStyleId()

Returns the Identifier assigned to this label.

Returns:

String

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Sets the CSS stylesheet class

Parameters:

styleClass - The CSS stylesheet class

getStyleClass

public java.lang.String getStyleClass()

Returns the CSS stylesheet class

Returns:

String the CSS stylesheet class

setStyle

public void setStyle(java.lang.String style)

Sets the CSS styles to be applied to this label.

Parameters:

style - The CSS styles for this label.

getStyle

public java.lang.String getStyle()

Returns the CSS styles for this label.

Returns:

String the CSS styles for this label.

getAlignment

public AlignmentType getAlignment()

Returns the alignment for the label

Returns:

the alignment for the label

setAlignment

public void setAlignment(AlignmentType alignment)

Sets the alignment for the label

Parameters:

alignment - The alignment

setImageRef

public void setImageRef(java.lang.String ref)

Assigns an Image from an ImageMap

Parameters:

ref - Rule of the ImageMap to match

getImageRef

public java.lang.String getImageRef()

Returns the assignment Rule

Returns:

String

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 max)

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

Parameters:

max - Maximum number of input characters to accept

isBodyInclude

public boolean isBodyInclude()

Returns if the header text was set within the body (true) or as an attribute (false)

Returns:

true if the body was specified; false otherwise

setBodyInclude

public void setBodyInclude(boolean include)

Sets if the header text is set within the body (true)

Parameters:

include - Flag which indicates if the body was set instead of the attribute

getWidth

public java.lang.String getWidth()

Returns the width of the label

Returns:

String The width.

setWidth

public void setWidth(java.lang.String width)

Sets the width of the label

Parameters:

width - The width of the label

getNowrap

public java.lang.Boolean getNowrap()

Returns the value of the nowrap attribute.

Returns:

Boolean or null if not set

setNowrap

public void setNowrap(java.lang.Boolean nowrap)

Sets the value of the nowrap attribute

Parameters:

nowrap - Boolean or null

setLocaleName

public void setLocaleName(java.lang.String locale)

Sets the Locale configuration for this element

Parameters:

locale - Locale Identifier or true|false

getLocaleName

public java.lang.String getLocaleName()

Gets the Local Setting for this element

Returns:

Locale Setting