com.cc.framework.ui.model
Interface ColumnDesignModel

All Superinterfaces:

AccessControlled, ActionBehavior, AjaxSupport, ClientHandler, DesignModel

All Known Subinterfaces:

ColumnButtonDesignModel, ColumnCheckboxDesignModel, ColumnCheckDesignModel, ColumnComboBoxDesignModel, ColumnCommandDesignModel, ColumnDrilldownDesignModel, ColumnGroupDesignModel, ColumnHtmlDesignModel, ColumnImageDesignModel, ColumnLinkDesignModel, ColumnRadioDesignModel, ColumnSelectDesignModel, ColumnTextareaDesignModel, ColumnTextDesignModel, ColumnTreeDesignModel

All Known Implementing Classes:

ColumnButtonDesignModelImp, ColumnCheckboxDesignModelImp, ColumnCheckDesignModelImp, ColumnComboBoxDesignModelImp, ColumnCommandDesignModelImp, ColumnDesignModelImp, ColumnDrilldownDesignModelImp, ColumnGroupDesignModelImp, ColumnHtmlDesignModelImp, ColumnImageDesignModelImp, ColumnLinkDesignModelImp, ColumnRadioDesignModelImp, ColumnSelectDesignModelImp, ColumnTextareaDesignModelImp, ColumnTextDesignModelImp, ColumnTreeDesignModelImp

public interface ColumnDesignModel

extends DesignModel, ClientHandler, AccessControlled, ActionBehavior, AjaxSupport

Defines the visual properties for a column of a list

Since:

1.0

Version:

$Revision: 1.42 $

Author:

Harald Schulz

Method Summary

void	addDesignRule(DesignRule rule) Adds a new design rule to the column
boolean	allowAjaxRendering() This method decides whether this column instance has enough information to be rendered as part of an AJAX response.
boolean	filter() Returns if the filter is activated (default=true).
AlignmentType	getAlignment() Returns the alignment for the column
java.lang.String	getAnchor() Returns the anchor that will be appended to all Hyperlinks for this column.
java.lang.String	getAnchorProperty() Returns the anchor property for the column.
Converter	getConverter() Returns the the Converter that should be used to convert Java Objects into their localized String representation.
DesignRule[]	getDesignRules() Returns the design rules for this column
java.lang.String	getDisableProperty() Retrieves the property which should be used to disable the column
java.lang.String	getEditableProperty() Retrieves the property which should be used to make the column editable or not
java.lang.String	getEnableProperty() Liefert den Namen der Eigenschaft, welche die Spaltendaten ermittelt, zurück
DeferredEnvironment	getEnvironment() Retrieves the EL Environment to evaluate EL Expressions in the context of the current row bean
ColumnHeaderDesignModel	getHeader() Returns the columns header design model
ImageMap	getImageMap() Returns the ImageMap
java.lang.String	getImageProperty() Returns the Property which should be used to identify an Image in an ImageMap
JoinMode	getJoinMode() Returns true when the column should be joined with the previous column.
java.lang.String	getLinkName() The anchor name to be defined within this page, so that you can reference it with intra-page hyperlinks.
java.lang.String	getLinkNameProperty() Returns the anchor name property for the column.
int	getMaxLength() Returns the maximal number of input characters which can be inserted into the text field.
java.lang.String	getProperty() Returns the name of the property which holds the data for the column
RunAt	getRunAt() Returns if the Control works with or without server round trips.
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	getTarget() Returns where the document referenced will appear.
java.lang.String	getTargetProperty() Returns the target property for the column.
java.lang.String	getTitle() Returns the title of the column
java.lang.String	getTooltip() Returns the static tooltip text
java.lang.String	getTooltipProperty() Returns the property used to access the tooltip.
boolean	getTransaction() Checks if the framework should include a transaction token (if any) in all generated hyperlinks for this column.
java.lang.String	getType() Returns the row bean type
java.lang.String	getWidth() Returns the width of the control
boolean	isDisabled() Returns the disabled state of the column
boolean	isEditable() Returns the edit state of the column
boolean	isSortable() Returns true if the column can be sorted.
void	setAlignment(AlignmentType alignment) Sets the alignment for the column
void	setAlignment(java.lang.String alignment) Sets the alignment for the column
void	setAnchor(java.lang.String anchor) Sets the anchor that should be appended to all Hyperlinks for this column.
void	setAnchorProperty(java.lang.String anchorProperty) Sets the name of the property where the value for the anchor attribute can be found in the data model.
void	setConverter(Converter converter) Sets the Converter that should be used to convert Java Objects into their localized String representation.
void	setDisabled(boolean disabled) Sets the disabled state of the column
void	setDisabled(java.lang.String disabled) Sets the disabled state of the column
void	setDisableProperty(java.lang.String property) Sets the property which should be used to disable the column
void	setEditable(boolean editable) Sets the edit state of the column
void	setEditable(java.lang.String editable) Sets the edit state of the column
void	setEditableProperty(java.lang.String property) Sets the property which should be used to make the column editable or not
void	setEnableProperty(java.lang.String property) Setzt den Namen der Eigenschaft mit deren Hilfe der Spaltenwert bestimmt werden kann.
void	setEnvironment(DeferredEnvironment env) Sets the EL Environment to evaluate EL Expressions in the context of the current row bean.
void	setFilter(boolean filter) Activates the HTML encoding (filter).
void	setFilter(java.lang.String filter) Activates the HTML encoding (filter).
void	setHeader(ColumnHeaderDesignModel header) Sets the columns header design model
void	setImageMap(ImageMap map) Assigns an ImageMap to the Column
void	setImageProperty(java.lang.String property) Sets the Property which should be used to identify an Image in an ImageMap
void	setJoinMode(JoinMode joinmode) Set to true if the column should be joined with the previous column.
void	setJoinMode(java.lang.String joinmode) Set to true if the column should be joined with the previous column.
void	setLinkName(java.lang.String linkName) Sets the anchor name to be defined within this page, so that you can reference it with intra-page hyperlinks.
void	setLinkNameProperty(java.lang.String linkNameProperty) Sets the name of the property where the value for the anchor name attribute can be found in the data model.
void	setMaxLength(int max) Sets the maximal number of input characters which can be inserted into the text field.
void	setMaxLength(java.lang.String max) Sets the maximal number of input characters which can be inserted into the text field.
void	setPermission(Permission permission) Sets a list with permissions needed to access this object.
void	setPermission(java.lang.String permission) Sets a list with permissions needed to access this object.
void	setProperty(java.lang.String property) Sets the name of the property which holds the data for the column
void	setRunAt(RunAt location) Defines if the Control works with or without server round trips.
void	setSortable(boolean sortable) Set to true if the column should be sortable.
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	setTarget(java.lang.String target) Sets the target where the document referenced will appear.
void	setTargetProperty(java.lang.String targetProperty) Sets the name of the property where the value for the target attribute can be found in the data model.
void	setTitle(java.lang.String title) Sets the title of the column
void	setTooltip(java.lang.String tooltip) Sets the static tooltip text.
void	setTooltipProperty(java.lang.String tooltipProperty) Sets the property which should be used to read the text for a tooltip.
void	setTransaction(boolean transaction) Directs the framework to include a transaction token (if any) in all generated hyperlinks for this column.
void	setType(java.lang.String type) Sets the type of the row bean
void	setWidth(int width) Sets the width of the column
void	setWidth(java.lang.String width) Sets the width of the column

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

setEnvironment

public void setEnvironment(DeferredEnvironment env)

Sets the EL Environment to evaluate EL Expressions in the context of the current row bean. The deferred environment should be set just before any getter of the column gets called. It should be set to null after the last getter has been called.

 try {
 	col.setEnvironment(env);
 
 	String width = col.getWidth();
 	String height = col.getHeight();
 
 	// call other members
 
 } catch (Exception e) {
 	// handle exception
 } finally {
 	col.setEnvironment(null);
 }
 

Parameters:

env - Environment

getEnvironment

public DeferredEnvironment getEnvironment()

Retrieves the EL Environment to evaluate EL Expressions in the context of the current row bean

Returns:

Environment or null

setRunAt

public void setRunAt(RunAt location)

Defines if the Control works with or without server round trips.

Parameters:

location - RunAt

getRunAt

public RunAt getRunAt()

Returns if the Control works with or without server round trips.

Returns:

RunAt

getType

public java.lang.String getType()

Returns the row bean type

Returns:

string

setType

public void setType(java.lang.String type)

Sets the type of the row bean

Parameters:

type - The type of the row bean

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

getHeader

public ColumnHeaderDesignModel getHeader()

Returns the columns header design model

Returns:

Design model

setHeader

public void setHeader(ColumnHeaderDesignModel header)

Sets the columns header design model

Parameters:

header - Design model

getWidth

public java.lang.String getWidth()

Returns the width of the control

Returns:

String The width.

setWidth

public void setWidth(int width)

Sets the width of the column

Parameters:

width - The width of the control

setWidth

public void setWidth(java.lang.String width)

Sets the width of the column

Parameters:

width - The width of the control

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

setMaxLength

public void setMaxLength(java.lang.String 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

getProperty

public java.lang.String getProperty()

Returns the name of the property which holds the data for the column

Returns:

String The name of the property

setProperty

public void setProperty(java.lang.String property)

Sets the name of the property which holds the data for the column

Parameters:

property - The name of the property.

getEnableProperty

public java.lang.String getEnableProperty()

Liefert den Namen der Eigenschaft, welche die Spaltendaten ermittelt, zurück

Returns:

Property

setEnableProperty

public void setEnableProperty(java.lang.String property)

Setzt den Namen der Eigenschaft mit deren Hilfe der Spaltenwert bestimmt werden kann.

Parameters:

property - Der Name der Eigenschaft

getImageProperty

public java.lang.String getImageProperty()

Returns the Property which should be used to identify an Image in an ImageMap

Returns:

String

setImageProperty

public void setImageProperty(java.lang.String property)

Sets the Property which should be used to identify an Image in an ImageMap

Parameters:

property - Property

setImageMap

public void setImageMap(ImageMap map)

Assigns an ImageMap to the Column

Parameters:

map - ImageMap

getImageMap

public ImageMap getImageMap()

Returns the ImageMap

Returns:

ImageMap

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

setAlignment

public void setAlignment(java.lang.String alignment)

Sets the alignment for the column

Parameters:

alignment - The alignment

isSortable

public boolean isSortable()

Returns true if the column can be sorted. The sort order must be specified in the state model.

Returns:

true if the column is sortable, false otherwise.

setSortable

public void setSortable(boolean sortable)

Set to true if the column should be sortable.

Parameters:

sortable - true if the column should be sortable.

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.

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

setFilter

public void setFilter(java.lang.String 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

setTarget

public void setTarget(java.lang.String target)

Sets the target where the document referenced will appear. (like _blank, _parent, ...). If you use this method each Hyperlinks in each row will use the same target value. If you want to use different targets you have to use a property which gets the target from your data model. Therefore you can specify the property with the setTargetProperty() method.

Parameters:

target - The target where the document referenced will appear

getTarget

public java.lang.String getTarget()

Returns where the document referenced will appear.

Returns:

String

setTargetProperty

public void setTargetProperty(java.lang.String targetProperty)

Sets the name of the property where the value for the target attribute can be found in the data model. So each row can have a different target value.

Parameters:

targetProperty - The target attribute to set

getTargetProperty

public java.lang.String getTargetProperty()

Returns the target property for the column.

Returns:

String

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

setTooltipProperty

public void setTooltipProperty(java.lang.String tooltipProperty)

Sets the property which should be used to read the text for a tooltip. This means that the tooltip is accessed using the getter Method specified by the argument.

Parameters:

tooltipProperty - The Target Attribute

getTooltipProperty

public java.lang.String getTooltipProperty()

Returns the property used to access the tooltip.

Returns:

String

setPermission

public void setPermission(Permission permission)

Sets a list with permissions needed to access this object. The list is separated by ';'

Parameters:

permission - Permission

setPermission

public void setPermission(java.lang.String permission)

Sets a list with permissions needed to access this object. The list is separated by ';'

Parameters:

permission - Permission

isEditable

public boolean isEditable()

Returns the edit state of the column

Returns:

Returns true if this column is editable

getEditableProperty

public java.lang.String getEditableProperty()

Retrieves the property which should be used to make the column editable or not

Returns:

the property name or null

setEditable

public void setEditable(boolean editable)

Sets the edit state of the column

Parameters:

editable - true to set the column editable

setEditable

public void setEditable(java.lang.String editable)

Sets the edit state of the column

Parameters:

editable - true to set the column editable

setEditableProperty

public void setEditableProperty(java.lang.String property)

Sets the property which should be used to make the column editable or not

Parameters:

property - the property name

isDisabled

public boolean isDisabled()

Returns the disabled state of the column

Returns:

Returns true if this column is disabled

getDisableProperty

public java.lang.String getDisableProperty()

Retrieves the property which should be used to disable the column

Returns:

the property name or null

setDisabled

public void setDisabled(boolean disabled)

Sets the disabled state of the column

Parameters:

disabled - true to set the column disabled

setDisabled

public void setDisabled(java.lang.String disabled)

Sets the disabled state of the column

Parameters:

disabled - true to set the column disabled

setDisableProperty

public void setDisableProperty(java.lang.String property)

Sets the property which should be used to disable the column

Parameters:

property - the property name

addDesignRule

public void addDesignRule(DesignRule rule)

Adds a new design rule to the column

Parameters:

rule - Design rule

getDesignRules

public DesignRule[] getDesignRules()

Returns the design rules for this column

Returns:

Array of design rules

setTransaction

public void setTransaction(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.

Parameters:

transaction - include transaction token

getTransaction

public boolean getTransaction()

Checks if the framework should include a transaction token (if any) in all generated hyperlinks for this column. 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

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 of the row beans column property.

The Converter is set for all rows of the columns. It is not possible to set individual converters for each row in a column!

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 row beans column property.

The Converter is set for all rows of the columns. It is not possible to set individual converters for each row in a column!

Parameters:

converter - Converters instance

setAnchor

public void setAnchor(java.lang.String anchor)

Sets the anchor that should be appended to all Hyperlinks for this column. If you use this method each Hyperlinks in each row will use the same anchor value. If you want to use different anchors you have to use a property which gets the anchor from your data model. Therefore you can specify the property with the setAnchorProperty() method.

Parameters:

anchor - The anchor

getAnchor

public java.lang.String getAnchor()

Returns the anchor that will be appended to all Hyperlinks for this column.

Returns:

String

setAnchorProperty

public void setAnchorProperty(java.lang.String anchorProperty)

Sets the name of the property where the value for the anchor attribute can be found in the data model. So each row can have a different anchor value.

Parameters:

anchorProperty - The anchor attribute to set

getAnchorProperty

public java.lang.String getAnchorProperty()

Returns the anchor property for the column.

Returns:

String

setLinkName

public void setLinkName(java.lang.String linkName)

Sets the anchor name to be defined within this page, so that you can reference it with intra-page hyperlinks. In other words, the value specified here will render a "name" element in the generated anchor tag. If you use this method each hyperlinks in each row will use the same linkName value. If you want to use different linkName you have to use a property which gets the linkName from your data model. Therefore you can specify the property with the setLinkNameProperty() method.

Parameters:

linkName - The link name

getLinkName

public java.lang.String getLinkName()

The anchor name to be defined within this page, so that you can reference it with intra-page hyperlinks. In other words, the value specified here will render a "name" element in the generated anchor tag.

Returns:

String

setLinkNameProperty

public void setLinkNameProperty(java.lang.String linkNameProperty)

Sets the name of the property where the value for the anchor name attribute can be found in the data model. So each row can have a different anchor name value.

Parameters:

linkNameProperty - The anchor name attribute to set

getLinkNameProperty

public java.lang.String getLinkNameProperty()

Returns the anchor name property for the column.

Returns:

String

getJoinMode

public JoinMode getJoinMode()

Returns true when the column should be joined with the previous column.

Returns:

boolean

setJoinMode

public void setJoinMode(JoinMode joinmode)

Set to true if the column should be joined with the previous column.

Parameters:

joinmode - true if the column should be joined.

setJoinMode

public void setJoinMode(java.lang.String joinmode)

Set to true if the column should be joined with the previous column.

Parameters:

joinmode - true if the column should be joined.

allowAjaxRendering

public boolean allowAjaxRendering()

This method decides whether this column instance has enough information to be rendered as part of an AJAX response.

Returns:

returns true when the column can be rendered in an AJAX response