com.cc.framework.ui.model
Interface ColumnHeaderDesignModel

All Superinterfaces:

ActionBehavior, AjaxSupport, ClientHandler, DesignModel

All Known Implementing Classes:

ColumnHeaderDesignModelImp

public interface ColumnHeaderDesignModel

extends DesignModel, ClientHandler, ActionBehavior, AjaxSupport

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).
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	isBodyInclude() Returns if the header text was set within the body (true) or as an attribute (false)
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	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 interface com.cc.framework.ui.model.ClientHandler

getHandler, getHandlers, setHandler

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

getTransaction, isAjaxEnabled

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

enableAjax, isAjaxEnabled

Method Detail

getTitle

public java.lang.String getTitle()

Returns the title of the column

Returns:

string

setTitle

public void setTitle(java.lang.String title)

Sets the title of the column

Parameters:

title - The title of the column

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

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 column.

Parameters:

id - The identifier to be assigned to this column.

getStyleId

public java.lang.String getStyleId()

Returns the Identifier assigned to this column.

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 column.

Parameters:

style - The CSS styles for this column.

getStyle

public java.lang.String getStyle()

Returns the CSS styles for this column.

Returns:

String the CSS styles for this column.

getAlignment

public AlignmentType getAlignment()

Returns the alignment for the column

Returns:

the alignment for the column

setAlignment

public void setAlignment(AlignmentType alignment)

Sets the alignment for the column

Parameters:

alignment - The alignment

setImageMap

public void setImageMap(ImageMap map)

Assigns an ImageMap to the column header

Parameters:

map - ImageMap

getImageMap

public ImageMap getImageMap()

Returns the ImageMap

Returns:

ImageMap

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

showHeader

public boolean showHeader()

Returns:

true if the column should show a column header

setTransaction

public void setTransaction(boolean transaction)

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

Parameters:

transaction - include transaction token