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

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

All Implemented Interfaces:

ActionBehavior, AjaxSupport, ClientHandler, ColumnHeaderDesignModel, DesignModel, java.io.Serializable

public class ColumnHeaderDesignModelImp

extends ClientHandlerImp

implements ColumnHeaderDesignModel, java.io.Serializable

Implementation of a header design model

Version:

$Revision: 1.12 $

Author:

Harald Schulz

See Also:

Serialized Form

Field Summary

private boolean	ajax set to true to enable AJAX.
private AlignmentType	alignment The alignment of the columnheader
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 ImageMap	imagemap An ImageMap for label images
private java.lang.String	imageref Image reference
private boolean	localize Specifies if localization is enabled
private int	maxLength Maximum number of visible characters
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 stylesheet 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	title The column title
private java.lang.String	tooltip Static tooltip Attribut
private boolean	transaction Directs the framework to include a transaction token (if any) in all generated hyperlinks for this column.

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

Constructor Summary

ColumnHeaderDesignModelImp()
Construktor

Method Summary

void	enableAjax(boolean enable) Enables or disables the AJAX behavior of the element
boolean	filter() Returns if the filter is activated (default=true).
AlignmentType	getAlignment() Returns the alignment for the column
ImageMap	getImageMap() Returns the ImageMap
java.lang.String	getImageRef() Returns the assignment Rule
int	getMaxLength() Returns the maximal number of input characters which can be inserted into the text field.
java.lang.String	getStyle() Returns the CSS styles for this column.
java.lang.String	getStyleClass() Returns the CSS stylesheet class
java.lang.String	getStyleId() Returns the Identifier assigned to this column.
java.lang.String	getTitle() Returns the title of the column
java.lang.String	getTooltip() Returns the static tooltip text
boolean	getTransaction() Checks if the framework should include a transaction token (if any) in all generated hyperlinks for this action.
boolean	isAjaxEnabled() This method checks if the element should send AJAX requests to the server
boolean	isBodyInclude() Returns if the header text was set within the body (true) or as an attribute (false)
boolean	localize()
void	setAlignment(AlignmentType alignment) Sets the alignment for the column
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	setImageMap(ImageMap map) Assigns an ImageMap to the column header
void	setImageRef(java.lang.String ref) Assigns an Image from an ImageMap
void	setLocalize(boolean localize)
void	setMaxLength(int max) Sets the maximal number of input characters which can be inserted into the text field.
void	setStyle(java.lang.String style) Sets the CSS styles to be applied to this column.
void	setStyleClass(java.lang.String styleClass) Sets the CSS stylesheet class
void	setStyleId(java.lang.String id) Identifier to be assigned to this column.
void	setTitle(java.lang.String title) Sets the title of the column
void	setTooltip(java.lang.String tooltip) Sets the static tooltip text.
void	setTransaction(boolean transaction) Directs the framework to include a transaction token (if any) in all generated hyperlinks.
boolean	showHeader()

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

title

private java.lang.String title

The column title

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 columnheader

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

localize

private boolean localize

Specifies if localization is enabled

tooltip

private java.lang.String tooltip

Static tooltip Attribut

imageref

private java.lang.String imageref

Image reference

imagemap

private ImageMap imagemap

An ImageMap for label images

transaction

private boolean transaction

Directs the framework to include a transaction token (if any) in all generated hyperlinks for this column. The Transaction token is used to track form re-submissions.When set to null the namespace will be searched for the Globals.TRANSACTION_KEY key

ajax

private boolean ajax

set to true to enable AJAX.

Constructor Detail

ColumnHeaderDesignModelImp

public ColumnHeaderDesignModelImp()

Construktor

Method Detail

showHeader

public boolean showHeader()

Specified by:

showHeader in interface ColumnHeaderDesignModel

Returns:

true if the column should show a column header

See Also:

ColumnHeaderDesignModel.showHeader()

getTitle

public java.lang.String getTitle()

Description copied from interface: ColumnHeaderDesignModel

Returns the title of the column

Specified by:

getTitle in interface ColumnHeaderDesignModel

Returns:

string

See Also:

ColumnHeaderDesignModel.getTitle()

setTitle

public void setTitle(java.lang.String title)

Description copied from interface: ColumnHeaderDesignModel

Sets the title of the column

Specified by:

setTitle in interface ColumnHeaderDesignModel

Parameters:

title - The title of the column

See Also:

ColumnHeaderDesignModel.setTitle(java.lang.String)

localize

public boolean localize()

Returns:

returns if the column header should be localized

setLocalize

public void setLocalize(boolean localize)

Parameters:

localize - Enables or disables the localization of the column header

filter

public boolean filter()

Description copied from interface: ColumnHeaderDesignModel

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 ColumnHeaderDesignModel

Returns:

true if string will be HTML encoded; false otherwise

See Also:

ColumnHeaderDesignModel.filter()

setFilter

public void setFilter(boolean filter)

Description copied from interface: ColumnHeaderDesignModel

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 ColumnHeaderDesignModel

Parameters:

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

See Also:

ColumnHeaderDesignModel.setFilter(boolean)

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Description copied from interface: ColumnHeaderDesignModel

Sets the CSS stylesheet class

Specified by:

setStyleClass in interface ColumnHeaderDesignModel

Parameters:

styleClass - The CSS stylesheet class

See Also:

ColumnHeaderDesignModel.setStyleClass(java.lang.String)

getStyleClass

public java.lang.String getStyleClass()

Description copied from interface: ColumnHeaderDesignModel

Returns the CSS stylesheet class

Specified by:

getStyleClass in interface ColumnHeaderDesignModel

Returns:

String the CSS stylesheet class

See Also:

ColumnHeaderDesignModel.getStyleClass()

setStyle

public void setStyle(java.lang.String style)

Description copied from interface: ColumnHeaderDesignModel

Sets the CSS styles to be applied to this column.

Specified by:

setStyle in interface ColumnHeaderDesignModel

Parameters:

style - The CSS styles for this column.

See Also:

ColumnHeaderDesignModel.setStyle(String)

getStyle

public java.lang.String getStyle()

Description copied from interface: ColumnHeaderDesignModel

Returns the CSS styles for this column.

Specified by:

getStyle in interface ColumnHeaderDesignModel

Returns:

String the CSS styles for this column.

See Also:

ColumnHeaderDesignModel.getStyle()

setStyleId

public void setStyleId(java.lang.String id)

Description copied from interface: ColumnHeaderDesignModel

Identifier to be assigned to this column.

Specified by:

setStyleId in interface ColumnHeaderDesignModel

Parameters:

id - The identifier to be assigned to this column.

See Also:

ColumnHeaderDesignModel.setStyleId(String id)

getStyleId

public java.lang.String getStyleId()

Description copied from interface: ColumnHeaderDesignModel

Returns the Identifier assigned to this column.

Specified by:

getStyleId in interface ColumnHeaderDesignModel

Returns:

String

See Also:

ColumnHeaderDesignModel.getStyleId()

getTooltip

public java.lang.String getTooltip()

Description copied from interface: ColumnHeaderDesignModel

Returns the static tooltip text

Specified by:

getTooltip in interface ColumnHeaderDesignModel

Returns:

String

See Also:

ColumnHeaderDesignModel.getTooltip()

setTooltip

public void setTooltip(java.lang.String tooltip)

Description copied from interface: ColumnHeaderDesignModel

Sets the static tooltip text.

Specified by:

setTooltip in interface ColumnHeaderDesignModel

Parameters:

tooltip - Tooltip text

See Also:

ColumnHeaderDesignModel.setTooltip(java.lang.String)

getAlignment

public AlignmentType getAlignment()

Description copied from interface: ColumnHeaderDesignModel

Returns the alignment for the column

Specified by:

getAlignment in interface ColumnHeaderDesignModel

Returns:

the alignment for the column

See Also:

ColumnHeaderDesignModel.getAlignment()

getImageMap

public ImageMap getImageMap()

Description copied from interface: ColumnHeaderDesignModel

Returns the ImageMap

Specified by:

getImageMap in interface ColumnHeaderDesignModel

Returns:

ImageMap

See Also:

ColumnHeaderDesignModel.getImageMap()

getImageRef

public java.lang.String getImageRef()

Description copied from interface: ColumnHeaderDesignModel

Returns the assignment Rule

Specified by:

getImageRef in interface ColumnHeaderDesignModel

Returns:

String

See Also:

ColumnHeaderDesignModel.getImageRef()

getMaxLength

public int getMaxLength()

Description copied from interface: ColumnHeaderDesignModel

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

Specified by:

getMaxLength in interface ColumnHeaderDesignModel

Returns:

Maximum number of input characters to accept

See Also:

ColumnHeaderDesignModel.getMaxLength()

setAlignment

public void setAlignment(AlignmentType alignment)

Description copied from interface: ColumnHeaderDesignModel

Sets the alignment for the column

Specified by:

setAlignment in interface ColumnHeaderDesignModel

Parameters:

alignment - The alignment

See Also:

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

setImageMap

public void setImageMap(ImageMap map)

Description copied from interface: ColumnHeaderDesignModel

Assigns an ImageMap to the column header

Specified by:

setImageMap in interface ColumnHeaderDesignModel

Parameters:

map - ImageMap

See Also:

ColumnHeaderDesignModel.setImageMap(com.cc.framework.ui.ImageMap)

setImageRef

public void setImageRef(java.lang.String ref)

Description copied from interface: ColumnHeaderDesignModel

Assigns an Image from an ImageMap

Specified by:

setImageRef in interface ColumnHeaderDesignModel

Parameters:

ref - Rule of the ImageMap to match

See Also:

ColumnHeaderDesignModel.setImageRef(java.lang.String)

setMaxLength

public void setMaxLength(int max)

Description copied from interface: ColumnHeaderDesignModel

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

Specified by:

setMaxLength in interface ColumnHeaderDesignModel

Parameters:

max - Maximum number of input characters to accept

See Also:

ColumnHeaderDesignModel.setMaxLength(int)

isBodyInclude

public boolean isBodyInclude()

Description copied from interface: ColumnHeaderDesignModel

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

Specified by:

isBodyInclude in interface ColumnHeaderDesignModel

Returns:

true if the body was specified; false otherwise

See Also:

ColumnHeaderDesignModel.isBodyInclude()

setBodyInclude

public void setBodyInclude(boolean include)

Description copied from interface: ColumnHeaderDesignModel

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

Specified by:

setBodyInclude in interface ColumnHeaderDesignModel

Parameters:

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

See Also:

ColumnHeaderDesignModel.setBodyInclude(boolean)

getTransaction

public boolean getTransaction()

Description copied from interface: ActionBehavior

Checks if the framework should include a transaction token (if any) in all generated hyperlinks for this action. The Transaction token is used to track form re-submissions.

Specified by:

getTransaction in interface ActionBehavior

Returns:

true if the transaction token should be generated

See Also:

ActionBehavior.getTransaction()

setTransaction

public void setTransaction(boolean transaction)

Description copied from interface: ColumnHeaderDesignModel

Directs the framework to include a transaction token (if any) in all generated hyperlinks. The Transaction token is used to track form re-submissions.

Specified by:

setTransaction in interface ColumnHeaderDesignModel

Parameters:

transaction - include transaction token

See Also:

ColumnHeaderDesignModel.setTransaction(boolean)

isAjaxEnabled

public boolean isAjaxEnabled()

Description copied from interface: ActionBehavior

This method checks if the element should send AJAX requests to the server

Specified by:

isAjaxEnabled in interface ActionBehavior

Returns:

returns true when the control should send AJAX requests.

See Also:

ActionBehavior.isAjaxEnabled()

enableAjax

public void enableAjax(boolean enable)

Description copied from interface: AjaxSupport

Enables or disables the AJAX behavior of the element

Specified by:

enableAjax in interface AjaxSupport

Parameters:

enable - set to true to enable AJAX.

See Also:

AjaxSupport.enableAjax(boolean)