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

java.lang.Object
  com.cc.framework.ui.model.imp.ClientHandlerImp
      com.cc.framework.ui.model.imp.FormLabelDesignModelImp

All Implemented Interfaces:

ClientHandler, DesignModel, FormLabelDesignModel, java.io.Serializable

public class FormLabelDesignModelImp

extends ClientHandlerImp

implements FormLabelDesignModel, java.io.Serializable

Implementation of a header design model

Version:

$Revision: 1.11 $

Author:

Harald Schulz

See Also:

Serialized Form

Field Summary

private 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).
private AlignmentType	alignment The alignment of the label
private boolean	bodyInclude Indicates whether the title is set within the body or as an attribute
private boolean	filter Specifies if all String should be converted into there HTML representation
private java.lang.String	imageref Image reference
private java.lang.String	localeName Locale Setting
private int	maxLength Maximum number of visible characters
private java.lang.Boolean	nowrap No wrap
private java.lang.String	prefix optional label prefix in plain HTML
private static long	serialVersionUID Serial Version UID
private java.lang.String	style CSS styles to be applied to this HTML element
private java.lang.String	styleClass CSS style sheet class to be applied to this HTML element
private java.lang.String	styleId Identifier to be assigned to this HTML element
private java.lang.String	suffix optional label suffix in plain HTML
private java.lang.String	text The label text
private java.lang.String	tooltip Static tooltip attribute
private java.lang.String	width The width of the label

Fields inherited from class com.cc.framework.ui.model.imp.ClientHandlerImp

Constructor Summary

FormLabelDesignModelImp()
Constructor

FormLabelDesignModelImp(java.lang.String text, java.lang.String imageref)
Constructor

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 class com.cc.framework.ui.model.imp.ClientHandlerImp

evaluate, getHandler, getHandlers, setHandler

Methods inherited from class java.lang.Object

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

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

getHandler, getHandlers, setHandler

Field Detail

serialVersionUID

private static final long serialVersionUID

Serial Version UID

See Also:

Constant Field Values

text

private java.lang.String text

The label text

suffix

private java.lang.String suffix

optional label suffix in plain HTML

prefix

private java.lang.String prefix

optional label prefix in plain HTML

bodyInclude

private boolean bodyInclude

Indicates whether the title is set within the body or as an attribute

alignment

private AlignmentType alignment

The alignment of the label

maxLength

private int maxLength

Maximum number of visible characters

styleId

private java.lang.String styleId

Identifier to be assigned to this HTML element

styleClass

private java.lang.String styleClass

CSS style sheet class to be applied to this HTML element

style

private java.lang.String style

CSS styles to be applied to this HTML element

filter

private boolean filter

Specifies if all String should be converted into there HTML representation

localeName

private java.lang.String localeName

Locale Setting

accessKey

private 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).

tooltip

private java.lang.String tooltip

Static tooltip attribute

imageref

private java.lang.String imageref

Image reference

width

private java.lang.String width

The width of the label

nowrap

private java.lang.Boolean nowrap

No wrap

Constructor Detail

FormLabelDesignModelImp

public FormLabelDesignModelImp()

Constructor

FormLabelDesignModelImp

public FormLabelDesignModelImp(java.lang.String text,
                               java.lang.String imageref)

Constructor

Parameters:

text - The Labels text

imageref - Label image

Method Detail

getText

public java.lang.String getText()

Description copied from interface: FormLabelDesignModel

Returns the labels text

Specified by:

getText in interface FormLabelDesignModel

Returns:

string

See Also:

FormLabelDesignModel.getText()

setText

public void setText(java.lang.String text)

Description copied from interface: FormLabelDesignModel

Sets the labels text

Specified by:

setText in interface FormLabelDesignModel

Parameters:

text - The label text

See Also:

FormLabelDesignModel.setText(java.lang.String)

filter

public boolean filter()

Description copied from interface: FormLabelDesignModel

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 FormLabelDesignModel

Returns:

true if string will be HTML encoded; false otherwise

See Also:

FormLabelDesignModel.filter()

setFilter

public void setFilter(boolean filter)

Description copied from interface: FormLabelDesignModel

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 FormLabelDesignModel

Parameters:

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

See Also:

FormLabelDesignModel.setFilter(boolean)

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Description copied from interface: FormLabelDesignModel

Sets the CSS stylesheet class

Specified by:

setStyleClass in interface FormLabelDesignModel

Parameters:

styleClass - The CSS stylesheet class

See Also:

FormLabelDesignModel.setStyleClass(java.lang.String)

getStyleClass

public java.lang.String getStyleClass()

Description copied from interface: FormLabelDesignModel

Returns the CSS stylesheet class

Specified by:

getStyleClass in interface FormLabelDesignModel

Returns:

String the CSS stylesheet class

See Also:

FormLabelDesignModel.getStyleClass()

setStyle

public void setStyle(java.lang.String style)

Description copied from interface: FormLabelDesignModel

Sets the CSS styles to be applied to this label.

Specified by:

setStyle in interface FormLabelDesignModel

Parameters:

style - The CSS styles for this label.

See Also:

FormLabelDesignModel.setStyle(String)

getStyle

public java.lang.String getStyle()

Description copied from interface: FormLabelDesignModel

Returns the CSS styles for this label.

Specified by:

getStyle in interface FormLabelDesignModel

Returns:

String the CSS styles for this label.

See Also:

FormLabelDesignModel.getStyle()

setStyleId

public void setStyleId(java.lang.String id)

Description copied from interface: FormLabelDesignModel

Identifier to be assigned to this label.

Specified by:

setStyleId in interface FormLabelDesignModel

Parameters:

id - The identifier to be assigned to this label.

See Also:

FormLabelDesignModel.setStyleId(String id)

getStyleId

public java.lang.String getStyleId()

Description copied from interface: FormLabelDesignModel

Returns the Identifier assigned to this label.

Specified by:

getStyleId in interface FormLabelDesignModel

Returns:

String

See Also:

FormLabelDesignModel.getStyleId()

getAccessKey

public java.lang.String getAccessKey()

Description copied from interface: FormLabelDesignModel

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

Specified by:

getAccessKey in interface FormLabelDesignModel

Returns:

The Access Key

See Also:

FormLabelDesignModel.getAccessKey()

setAccessKey

public void setAccessKey(java.lang.String accessKey)

Description copied from interface: FormLabelDesignModel

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

Specified by:

setAccessKey in interface FormLabelDesignModel

Parameters:

accessKey - The Access Key

See Also:

FormLabelDesignModel.setAccessKey(java.lang.String)

getTooltip

public java.lang.String getTooltip()

Description copied from interface: FormLabelDesignModel

Returns the static tooltip text

Specified by:

getTooltip in interface FormLabelDesignModel

Returns:

String

See Also:

FormLabelDesignModel.getTooltip()

setTooltip

public void setTooltip(java.lang.String tooltip)

Description copied from interface: FormLabelDesignModel

Sets the static tooltip text.

Specified by:

setTooltip in interface FormLabelDesignModel

Parameters:

tooltip - Tooltip text

See Also:

FormLabelDesignModel.setTooltip(java.lang.String)

getAlignment

public AlignmentType getAlignment()

Description copied from interface: FormLabelDesignModel

Returns the alignment for the label

Specified by:

getAlignment in interface FormLabelDesignModel

Returns:

the alignment for the label

See Also:

FormLabelDesignModel.getAlignment()

getImageRef

public java.lang.String getImageRef()

Description copied from interface: FormLabelDesignModel

Returns the assignment Rule

Specified by:

getImageRef in interface FormLabelDesignModel

Returns:

String

See Also:

FormLabelDesignModel.getImageRef()

getMaxLength

public int getMaxLength()

Description copied from interface: FormLabelDesignModel

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

Specified by:

getMaxLength in interface FormLabelDesignModel

Returns:

Maximum number of input characters to accept

See Also:

FormLabelDesignModel.getMaxLength()

setAlignment

public void setAlignment(AlignmentType alignment)

Description copied from interface: FormLabelDesignModel

Sets the alignment for the label

Specified by:

setAlignment in interface FormLabelDesignModel

Parameters:

alignment - The alignment

See Also:

FormLabelDesignModel.setAlignment(com.cc.framework.ui.AlignmentType)

setImageRef

public void setImageRef(java.lang.String ref)

Description copied from interface: FormLabelDesignModel

Assigns an Image from an ImageMap

Specified by:

setImageRef in interface FormLabelDesignModel

Parameters:

ref - Rule of the ImageMap to match

See Also:

FormLabelDesignModel.setImageRef(java.lang.String)

setMaxLength

public void setMaxLength(int max)

Description copied from interface: FormLabelDesignModel

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

Specified by:

setMaxLength in interface FormLabelDesignModel

Parameters:

max - Maximum number of input characters to accept

See Also:

FormLabelDesignModel.setMaxLength(int)

isBodyInclude

public boolean isBodyInclude()

Description copied from interface: FormLabelDesignModel

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

Specified by:

isBodyInclude in interface FormLabelDesignModel

Returns:

true if the body was specified; false otherwise

See Also:

FormLabelDesignModel.isBodyInclude()

setBodyInclude

public void setBodyInclude(boolean include)

Description copied from interface: FormLabelDesignModel

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

Specified by:

setBodyInclude in interface FormLabelDesignModel

Parameters:

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

See Also:

FormLabelDesignModel.setBodyInclude(boolean)

getWidth

public java.lang.String getWidth()

Description copied from interface: FormLabelDesignModel

Returns the width of the label

Specified by:

getWidth in interface FormLabelDesignModel

Returns:

String The width.

See Also:

FormLabelDesignModel.getWidth()

setWidth

public void setWidth(java.lang.String width)

Description copied from interface: FormLabelDesignModel

Sets the width of the label

Specified by:

setWidth in interface FormLabelDesignModel

Parameters:

width - The width of the label

See Also:

FormLabelDesignModel.setWidth(java.lang.String)

getNowrap

public java.lang.Boolean getNowrap()

Description copied from interface: FormLabelDesignModel

Returns the value of the nowrap attribute.

Specified by:

getNowrap in interface FormLabelDesignModel

Returns:

Boolean or null if not set

See Also:

FormLabelDesignModel.getNowrap()

setNowrap

public void setNowrap(java.lang.Boolean nowrap)

Description copied from interface: FormLabelDesignModel

Sets the value of the nowrap attribute

Specified by:

setNowrap in interface FormLabelDesignModel

Parameters:

nowrap - Boolean or null

See Also:

FormLabelDesignModel.setNowrap(java.lang.Boolean)

getLocaleName

public java.lang.String getLocaleName()

Description copied from interface: FormLabelDesignModel

Gets the Local Setting for this element

Specified by:

getLocaleName in interface FormLabelDesignModel

Returns:

Locale Setting

See Also:

FormLabelDesignModel.getLocaleName()

setLocaleName

public void setLocaleName(java.lang.String locale)

Description copied from interface: FormLabelDesignModel

Sets the Locale configuration for this element

Specified by:

setLocaleName in interface FormLabelDesignModel

Parameters:

locale - Locale Identifier or true|false

See Also:

FormLabelDesignModel.setLocaleName(java.lang.String)

getPrefix

public java.lang.String getPrefix()

Description copied from interface: FormLabelDesignModel

Retrieves the optional label prefix in plain HTML

Specified by:

getPrefix in interface FormLabelDesignModel

Returns:

Prefix (plain HTML) or null

See Also:

FormLabelDesignModel.getPrefix()

getSuffix

public java.lang.String getSuffix()

Description copied from interface: FormLabelDesignModel

Retrieves the optional label suffix in plain HTML

Specified by:

getSuffix in interface FormLabelDesignModel

Returns:

Suffix (plain HTML) or null

See Also:

FormLabelDesignModel.getSuffix()

setPrefix

public void setPrefix(java.lang.String prefix)

Description copied from interface: FormLabelDesignModel

Specifies the label prefix in plain HTML

Specified by:

setPrefix in interface FormLabelDesignModel

Parameters:

prefix - The label prefix

See Also:

FormLabelDesignModel.setPrefix(java.lang.String)

setSuffix

public void setSuffix(java.lang.String suffix)

Description copied from interface: FormLabelDesignModel

Specifies the label suffix in plain HTML

Specified by:

setSuffix in interface FormLabelDesignModel

Parameters:

suffix - The label suffix

See Also:

FormLabelDesignModel.setSuffix(java.lang.String)