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

java.lang.Object
  extended bycom.cc.framework.ui.model.imp.ClientHandlerImp
      extended bycom.cc.framework.ui.model.imp.ColumnDesignModelImp
All Implemented Interfaces:
AccessControlled, ActionBehavior, AjaxSupport, ClientHandler, ColumnDesignModel, DesignModel, java.io.Serializable
Direct Known Subclasses:
ColumnButtonDesignModelImp, ColumnCheckDesignModelImp, ColumnComboBoxDesignModelImp, ColumnCommandDesignModelImp, ColumnDrilldownDesignModelImp, ColumnGroupDesignModelImp, ColumnHtmlDesignModelImp, ColumnImageDesignModelImp, ColumnLinkDesignModelImp, ColumnSelectDesignModelImp, ColumnTextareaDesignModelImp, ColumnTextDesignModelImp, ColumnTreeDesignModelImp

public abstract class ColumnDesignModelImp
extends ClientHandlerImp
implements ColumnDesignModel, java.io.Serializable

Designmodel for columns

Since:
1.0
Version:
$Revision: 1.45 $
Author:
Harald Schulz
See Also:
Serialized Form

Field Summary
private  boolean ajax
          set to true to enable AJAX.
private  DeferredValue alignment
          The alignment of the column
private  DeferredValue anchor
          Anchor Attribute
private  DeferredValue anchorProperty
          Name of the Property to acquire the Anchor-Attribute
private  Converter converter
          The converter that should be used to convert Java Objects into their localized String representation.
private  java.util.ArrayList designRules
          Design rules
private  DeferredValue disabled
          Indicates if this column is disabled
private  DeferredValue disableProperty
          The property which should be used to disable the column
private  DeferredValue editable
          Indicates if this column is editable
private  DeferredValue editableProperty
          The property which should be used to make the column editable or not
private  DeferredValue enableProperty
          Field enableProperty
private  DeferredEnvironment env
          Expression Language Environment.
private  DeferredValue filter
          Specifies if all String should be converted into there HTML representation
private  ColumnHeaderDesignModel header
          The columns header
private  ImageMap imagemap
          An ImageMap for label images
private  DeferredValue imageProperty
          Name of the property which returns a expression/string used to identify an image in the ImageMap.
private  DeferredValue joinMode
          Indicates if this column should be joined with the previous column
private  DeferredValue linkName
          The anchor name to be defined within this page, so that you can reference it with intra-page Hyperlinks.
private  DeferredValue linkNameProperty
          Name of the Property to acquire the Anchor name-Attribute
private  DeferredValue maxLength
          Maximum number of visible characters
private  DeferredValue permission
          Permissions to access this Column
private  DeferredValue property
          The name of the property for the column which indicates which data to show.
private  RunAt runat
          Indicates if the control works with or without server round trips
private static long serialVersionUID
          Serial Version UID
private  boolean sortable
          Indicates if this column can be sorted
private  DeferredValue style
          CSS styles to be applied to this HTML element
private  DeferredValue styleClass
          CSS Stylesheet class to be applied to this HTML element
private  DeferredValue styleId
          Identifier to be assigned to this HTML element
private  DeferredValue target
          Target Attribute
private  DeferredValue targetProperty
          Name of the Property to acquire the Target-Attribute
private  DeferredValue tooltip
          Static tooltip Attribute
private  DeferredValue tooltipProperty
          Name of the Property to acquire the Tooltip-Attribute
private  boolean transaction
          Directs the framework to include a transaction token (if any) in all generated Hyperlinks for this column.
private  java.lang.String type
          The columns property class name
private  DeferredValue width
          The width of the column
 
Fields inherited from class com.cc.framework.ui.model.imp.ClientHandlerImp
 
Constructor Summary
ColumnDesignModelImp()
          Constructor for ColumnDesignModelImp
 
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.
 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
 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 current EL Environment for the current row
 java.lang.String getHandler(ClientEvent event)
          Returns the script handler which was associated for a client event
 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.
 Permission getPermission()
          Returns the authorizations required to access an object If the method returns null no access rights is required.
 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 columns property class name
 java.lang.String getWidth()
          Returns the width of the control
 boolean isAjaxEnabled()
          This method checks if the element should send AJAX requests to the server
 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)
          Disablea the column
 void setDisabled(java.lang.String disabled)
          Disables 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 column editable
 void setEditable(java.lang.String editable)
          Sets the column editable
 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)
          Joins the column 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 maxLength)
          Sets the maximal number of input characters which can be inserted into the text field.
 void setMaxLength(java.lang.String maxLength)
          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
 boolean show(Principal principal)
          Checks if the Object has a required permission.
 
Methods inherited from class com.cc.framework.ui.model.imp.ClientHandlerImp
evaluate, 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
getHandlers, setHandler
 

Field Detail

serialVersionUID

private static final long serialVersionUID
Serial Version UID

See Also:
Constant Field Values

env

private transient DeferredEnvironment env
Expression Language Environment. This object is needed when the property values of the column are retrieved in the context of a row bean. Properties might change from row to row because they can contain dynamic expressions


type

private java.lang.String type
The columns property class name


header

private ColumnHeaderDesignModel header
The columns header


runat

private RunAt runat
Indicates if the control works with or without server round trips


designRules

private java.util.ArrayList designRules
Design rules


imagemap

private ImageMap imagemap
An ImageMap for label images


sortable

private boolean sortable
Indicates if this column can be sorted


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.


ajax

private boolean ajax
set to true to enable AJAX.


property

private DeferredValue property
The name of the property for the column which indicates which data to show.


enableProperty

private DeferredValue enableProperty
Field enableProperty


editable

private DeferredValue editable
Indicates if this column is editable


editableProperty

private DeferredValue editableProperty
The property which should be used to make the column editable or not


disabled

private DeferredValue disabled
Indicates if this column is disabled


disableProperty

private DeferredValue disableProperty
The property which should be used to disable the column


imageProperty

private DeferredValue imageProperty
Name of the property which returns a expression/string used to identify an image in the ImageMap.


permission

private DeferredValue permission
Permissions to access this Column


converter

private Converter converter
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.


width

private DeferredValue width
The width of the column


maxLength

private DeferredValue maxLength
Maximum number of visible characters


alignment

private DeferredValue alignment
The alignment of the column


styleId

private DeferredValue styleId
Identifier to be assigned to this HTML element


styleClass

private DeferredValue styleClass
CSS Stylesheet class to be applied to this HTML element


style

private DeferredValue style
CSS styles to be applied to this HTML element


filter

private DeferredValue filter
Specifies if all String should be converted into there HTML representation


target

private DeferredValue target
Target Attribute


targetProperty

private DeferredValue targetProperty
Name of the Property to acquire the Target-Attribute


tooltip

private DeferredValue tooltip
Static tooltip Attribute


tooltipProperty

private DeferredValue tooltipProperty
Name of the Property to acquire the Tooltip-Attribute


anchor

private DeferredValue anchor
Anchor Attribute


anchorProperty

private DeferredValue anchorProperty
Name of the Property to acquire the Anchor-Attribute


linkName

private DeferredValue linkName
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.


linkNameProperty

private DeferredValue linkNameProperty
Name of the Property to acquire the Anchor name-Attribute


joinMode

private DeferredValue joinMode
Indicates if this column should be joined with the previous column

Constructor Detail

ColumnDesignModelImp

public ColumnDesignModelImp()
Constructor for ColumnDesignModelImp

Method Detail

setEnvironment

public void setEnvironment(DeferredEnvironment env)
Sets the EL Environment to evaluate EL Expressions in the context of the current row bean

Specified by:
setEnvironment in interface ColumnDesignModel
Parameters:
env - Environment

getEnvironment

public DeferredEnvironment getEnvironment()
retrieves the current EL Environment for the current row

Specified by:
getEnvironment in interface ColumnDesignModel
Returns:
Environment oder null

isEditable

public boolean isEditable()
Description copied from interface: ColumnDesignModel
Returns the edit state of the column

Specified by:
isEditable in interface ColumnDesignModel
Returns:
Returns true if this column is editable
See Also:
ColumnDesignModel.isEditable()

setEditable

public void setEditable(boolean editable)
Sets the column editable

Specified by:
setEditable in interface ColumnDesignModel
Parameters:
editable - true to set the column editable
See Also:
ColumnDesignModel.setEditable(boolean)

setEditable

public void setEditable(java.lang.String editable)
Sets the column editable

Specified by:
setEditable in interface ColumnDesignModel
Parameters:
editable - true to set the column editable
See Also:
ColumnDesignModel.setEditable(java.lang.String)

getEditableProperty

public java.lang.String getEditableProperty()
Description copied from interface: ColumnDesignModel
Retrieves the property which should be used to make the column editable or not

Specified by:
getEditableProperty in interface ColumnDesignModel
Returns:
the property name or null
See Also:
ColumnDesignModel.getEditableProperty()

setEditableProperty

public void setEditableProperty(java.lang.String property)
Description copied from interface: ColumnDesignModel
Sets the property which should be used to make the column editable or not

Specified by:
setEditableProperty in interface ColumnDesignModel
Parameters:
property - the property name
See Also:
ColumnDesignModel.setEditableProperty(java.lang.String)

isDisabled

public boolean isDisabled()
Description copied from interface: ColumnDesignModel
Returns the disabled state of the column

Specified by:
isDisabled in interface ColumnDesignModel
Returns:
Returns true if this column is disabled
See Also:
ColumnDesignModel.isDisabled()

setDisabled

public void setDisabled(boolean disabled)
Disablea the column

Specified by:
setDisabled in interface ColumnDesignModel
Parameters:
disabled - true to set the column disabled
See Also:
ColumnDesignModel.setDisabled(boolean)

setDisabled

public void setDisabled(java.lang.String disabled)
Disables the column

Specified by:
setDisabled in interface ColumnDesignModel
Parameters:
disabled - true to set the column disabled
See Also:
ColumnDesignModel.setDisabled(java.lang.String)

getDisableProperty

public java.lang.String getDisableProperty()
Description copied from interface: ColumnDesignModel
Retrieves the property which should be used to disable the column

Specified by:
getDisableProperty in interface ColumnDesignModel
Returns:
the property name or null
See Also:
ColumnDesignModel.getDisableProperty()

setDisableProperty

public void setDisableProperty(java.lang.String property)
Description copied from interface: ColumnDesignModel
Sets the property which should be used to disable the column

Specified by:
setDisableProperty in interface ColumnDesignModel
Parameters:
property - the property name
See Also:
ColumnDesignModel.setDisableProperty(java.lang.String)

getType

public java.lang.String getType()
Returns the columns property class name

Specified by:
getType in interface ColumnDesignModel
Returns:
string

setType

public void setType(java.lang.String type)
Sets the type of the row bean

Specified by:
setType in interface ColumnDesignModel
Parameters:
type - The type of the row bean

getAlignment

public AlignmentType getAlignment()
Description copied from interface: ColumnDesignModel
Returns the alignment for the column

Specified by:
getAlignment in interface ColumnDesignModel
Returns:
the alignment for the column
See Also:
ColumnDesignModel.getAlignment()

setAlignment

public void setAlignment(AlignmentType alignment)
Description copied from interface: ColumnDesignModel
Sets the alignment for the column

Specified by:
setAlignment in interface ColumnDesignModel
Parameters:
alignment - The alignment
See Also:
ColumnDesignModel.setAlignment(AlignmentType)

setAlignment

public void setAlignment(java.lang.String alignment)
Description copied from interface: ColumnDesignModel
Sets the alignment for the column

Specified by:
setAlignment in interface ColumnDesignModel
Parameters:
alignment - The alignment
See Also:
ColumnDesignModel.setAlignment(java.lang.String)

getWidth

public java.lang.String getWidth()
Description copied from interface: ColumnDesignModel
Returns the width of the control

Specified by:
getWidth in interface ColumnDesignModel
Returns:
String The width.
See Also:
ColumnDesignModel.getWidth()

setWidth

public void setWidth(int width)
Description copied from interface: ColumnDesignModel
Sets the width of the column

Specified by:
setWidth in interface ColumnDesignModel
Parameters:
width - The width of the control
See Also:
ColumnDesignModel.setWidth(int)

setWidth

public void setWidth(java.lang.String width)
Description copied from interface: ColumnDesignModel
Sets the width of the column

Specified by:
setWidth in interface ColumnDesignModel
Parameters:
width - The width of the control
See Also:
ColumnDesignModel.setWidth(String)

getMaxLength

public int getMaxLength()
Description copied from interface: ColumnDesignModel
Returns the maximal number of input characters which can be inserted into the text field.

Specified by:
getMaxLength in interface ColumnDesignModel
Returns:
Maximum number of input characters to accept
See Also:
ColumnDesignModel.getMaxLength()

setMaxLength

public void setMaxLength(int maxLength)
Description copied from interface: ColumnDesignModel
Sets the maximal number of input characters which can be inserted into the text field.

Specified by:
setMaxLength in interface ColumnDesignModel
Parameters:
maxLength - Maximum number of input characters to accept
See Also:
ColumnDesignModel.setMaxLength(int)

setMaxLength

public void setMaxLength(java.lang.String maxLength)
Description copied from interface: ColumnDesignModel
Sets the maximal number of input characters which can be inserted into the text field.

Specified by:
setMaxLength in interface ColumnDesignModel
Parameters:
maxLength - Maximum number of input characters to accept
See Also:
ColumnDesignModel.setMaxLength(java.lang.String)

getProperty

public java.lang.String getProperty()
Description copied from interface: ColumnDesignModel
Returns the name of the property which holds the data for the column

Specified by:
getProperty in interface ColumnDesignModel
Returns:
String The name of the property
See Also:
ColumnDesignModel.getProperty()

setProperty

public void setProperty(java.lang.String property)
Description copied from interface: ColumnDesignModel
Sets the name of the property which holds the data for the column

Specified by:
setProperty in interface ColumnDesignModel
Parameters:
property - The name of the property.
See Also:
ColumnDesignModel.setProperty(String)

isSortable

public boolean isSortable()
Description copied from interface: ColumnDesignModel
Returns true if the column can be sorted. The sort order must be specified in the state model.

Specified by:
isSortable in interface ColumnDesignModel
Returns:
true if the column is sortable, false otherwise.
See Also:
ColumnDesignModel.isSortable()

setSortable

public void setSortable(boolean sortable)
Description copied from interface: ColumnDesignModel
Set to true if the column should be sortable.

Specified by:
setSortable in interface ColumnDesignModel
Parameters:
sortable - true if the column should be sortable.
See Also:
ColumnDesignModel.setSortable(boolean)

getEnableProperty

public java.lang.String getEnableProperty()
Description copied from interface: ColumnDesignModel
Liefert den Namen der Eigenschaft, welche die Spaltendaten ermittelt, zurück

Specified by:
getEnableProperty in interface ColumnDesignModel
Returns:
Property
See Also:
ColumnDesignModel.getEnableProperty()

setEnableProperty

public void setEnableProperty(java.lang.String property)
Description copied from interface: ColumnDesignModel
Setzt den Namen der Eigenschaft mit deren Hilfe der Spaltenwert bestimmt werden kann.

Specified by:
setEnableProperty in interface ColumnDesignModel
Parameters:
property - Der Name der Eigenschaft
See Also:
ColumnDesignModel.setEnableProperty(String)

setStyleId

public void setStyleId(java.lang.String id)
Description copied from interface: ColumnDesignModel
Identifier to be assigned to this column.

Specified by:
setStyleId in interface ColumnDesignModel
Parameters:
id - The identifier to be assigned to this column.
See Also:
ColumnDesignModel.setStyleId(String id)

getStyleId

public java.lang.String getStyleId()
Description copied from interface: ColumnDesignModel
Returns the Identifier assigned to this column.

Specified by:
getStyleId in interface ColumnDesignModel
Returns:
String
See Also:
ColumnDesignModel.getStyleId()

getPermission

public Permission getPermission()
Description copied from interface: AccessControlled
Returns the authorizations required to access an object If the method returns null no access rights is required.

Specified by:
getPermission in interface AccessControlled
Returns:
Permission A list with required permissions separated by ";"
See Also:
AccessControlled.getPermission()

setPermission

public void setPermission(Permission permission)
Description copied from interface: ColumnDesignModel
Sets a list with permissions needed to access this object. The list is separated by ';'

Specified by:
setPermission in interface ColumnDesignModel
Parameters:
permission - Permission
See Also:
ColumnDesignModel.setPermission(com.cc.framework.security.Permission)

setPermission

public void setPermission(java.lang.String permission)
Description copied from interface: ColumnDesignModel
Sets a list with permissions needed to access this object. The list is separated by ';'

Specified by:
setPermission in interface ColumnDesignModel
Parameters:
permission - Permission
See Also:
ColumnDesignModel.setPermission(java.lang.String)

show

public boolean show(Principal principal)
Description copied from interface: AccessControlled
Checks if the Object has a required permission.

Specified by:
show in interface AccessControlled
Parameters:
principal - the users principal object
Returns:
true if the permission exists
See Also:
AccessControlled.show(Principal)

filter

public boolean filter()
Description copied from interface: ColumnDesignModel
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 ColumnDesignModel
Returns:
true if string will be HTML encoded; false otherwise
See Also:
ColumnDesignModel.filter()

setFilter

public void setFilter(boolean filter)
Description copied from interface: ColumnDesignModel
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 ColumnDesignModel
Parameters:
filter - true if strings should be HTML encoded; false otherwise
See Also:
ColumnDesignModel.setFilter(boolean)

setFilter

public void setFilter(java.lang.String filter)
Description copied from interface: ColumnDesignModel
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 ColumnDesignModel
Parameters:
filter - true if strings should be HTML encoded; false otherwise
See Also:
ColumnDesignModel.setFilter(java.lang.String)

setStyleClass

public void setStyleClass(java.lang.String styleClass)
Description copied from interface: ColumnDesignModel
Sets the CSS Stylesheet class

Specified by:
setStyleClass in interface ColumnDesignModel
Parameters:
styleClass - The CSS Stylesheet class
See Also:
ColumnDesignModel.setStyleClass(java.lang.String)

getStyleClass

public java.lang.String getStyleClass()
Description copied from interface: ColumnDesignModel
Returns the CSS Stylesheet class

Specified by:
getStyleClass in interface ColumnDesignModel
Returns:
String the CSS stylesheet class
See Also:
ColumnDesignModel.getStyleClass()

setStyle

public void setStyle(java.lang.String style)
Description copied from interface: ColumnDesignModel
Sets the CSS styles to be applied to this column.

Specified by:
setStyle in interface ColumnDesignModel
Parameters:
style - The CSS styles for this column.
See Also:
ColumnDesignModel.setStyle(java.lang.String)

getStyle

public java.lang.String getStyle()
Description copied from interface: ColumnDesignModel
Returns the CSS styles for this column.

Specified by:
getStyle in interface ColumnDesignModel
Returns:
String the CSS styles for this column.
See Also:
ColumnDesignModel.getStyle()

setRunAt

public void setRunAt(RunAt location)
Description copied from interface: ColumnDesignModel
Defines if the Control works with or without server round trips.

Specified by:
setRunAt in interface ColumnDesignModel
Parameters:
location - RunAt
See Also:
ColumnDesignModel.setRunAt(RunAt)

getRunAt

public RunAt getRunAt()
Description copied from interface: ColumnDesignModel
Returns if the Control works with or without server round trips.

Specified by:
getRunAt in interface ColumnDesignModel
Returns:
RunAt
See Also:
ColumnDesignModel.getRunAt()

setTarget

public void setTarget(java.lang.String target)
Description copied from interface: ColumnDesignModel
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.

Specified by:
setTarget in interface ColumnDesignModel
Parameters:
target - The target where the document referenced will appear
See Also:
ColumnDesignModel.setTarget(String)

getTarget

public java.lang.String getTarget()
Description copied from interface: ColumnDesignModel
Returns where the document referenced will appear.

Specified by:
getTarget in interface ColumnDesignModel
Returns:
String
See Also:
ColumnDesignModel.getTarget()

setTargetProperty

public void setTargetProperty(java.lang.String targetProperty)
Description copied from interface: ColumnDesignModel
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.

Specified by:
setTargetProperty in interface ColumnDesignModel
Parameters:
targetProperty - The target attribute to set
See Also:
ColumnDesignModel.setTargetProperty(String)

getTargetProperty

public java.lang.String getTargetProperty()
Description copied from interface: ColumnDesignModel
Returns the target property for the column.

Specified by:
getTargetProperty in interface ColumnDesignModel
Returns:
String
See Also:
ColumnDesignModel.getTargetProperty()

getImageProperty

public java.lang.String getImageProperty()
Description copied from interface: ColumnDesignModel
Returns the Property which should be used to identify an Image in an ImageMap

Specified by:
getImageProperty in interface ColumnDesignModel
Returns:
String
See Also:
ColumnDesignModel.getImageProperty()

setImageProperty

public void setImageProperty(java.lang.String property)
Description copied from interface: ColumnDesignModel
Sets the Property which should be used to identify an Image in an ImageMap

Specified by:
setImageProperty in interface ColumnDesignModel
Parameters:
property - Property
See Also:
ColumnDesignModel.setImageProperty(java.lang.String)

setImageMap

public void setImageMap(ImageMap map)
Description copied from interface: ColumnDesignModel
Assigns an ImageMap to the Column

Specified by:
setImageMap in interface ColumnDesignModel
Parameters:
map - ImageMap
See Also:
ColumnDesignModel.setImageMap(com.cc.framework.ui.ImageMap)

getImageMap

public ImageMap getImageMap()
Description copied from interface: ColumnDesignModel
Returns the ImageMap

Specified by:
getImageMap in interface ColumnDesignModel
Returns:
ImageMap
See Also:
ColumnDesignModel.getImageMap()

getTooltip

public java.lang.String getTooltip()
Description copied from interface: ColumnDesignModel
Returns the static tooltip text

Specified by:
getTooltip in interface ColumnDesignModel
Returns:
String
See Also:
ColumnDesignModel.getTooltip()

setTooltip

public void setTooltip(java.lang.String tooltip)
Description copied from interface: ColumnDesignModel
Sets the static tooltip text.

Specified by:
setTooltip in interface ColumnDesignModel
Parameters:
tooltip - Tooltip text
See Also:
ColumnDesignModel.setTooltip(java.lang.String)

getTooltipProperty

public java.lang.String getTooltipProperty()
Description copied from interface: ColumnDesignModel
Returns the property used to access the tooltip.

Specified by:
getTooltipProperty in interface ColumnDesignModel
Returns:
String
See Also:
ColumnDesignModel.getTooltipProperty()

setTooltipProperty

public void setTooltipProperty(java.lang.String tooltipProperty)
Description copied from interface: ColumnDesignModel
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.

Specified by:
setTooltipProperty in interface ColumnDesignModel
Parameters:
tooltipProperty - The Target Attribute
See Also:
ColumnDesignModel.setTooltipProperty(java.lang.String)

getHeader

public ColumnHeaderDesignModel getHeader()
Description copied from interface: ColumnDesignModel
Returns the columns header design model

Specified by:
getHeader in interface ColumnDesignModel
Returns:
Design model
See Also:
ColumnDesignModel.getHeader()

setHeader

public void setHeader(ColumnHeaderDesignModel header)
Description copied from interface: ColumnDesignModel
Sets the columns header design model

Specified by:
setHeader in interface ColumnDesignModel
Parameters:
header - Design model
See Also:
ColumnDesignModel.setHeader(com.cc.framework.ui.model.ColumnHeaderDesignModel)

getTitle

public java.lang.String getTitle()
Description copied from interface: ColumnDesignModel
Returns the title of the column

Specified by:
getTitle in interface ColumnDesignModel
Returns:
string
See Also:
ColumnDesignModel.getTitle()

setTitle

public void setTitle(java.lang.String title)
Description copied from interface: ColumnDesignModel
Sets the title of the column

Specified by:
setTitle in interface ColumnDesignModel
Parameters:
title - The title of the column
See Also:
ColumnDesignModel.setTitle(String)

addDesignRule

public void addDesignRule(DesignRule rule)
Description copied from interface: ColumnDesignModel
Adds a new design rule to the column

Specified by:
addDesignRule in interface ColumnDesignModel
Parameters:
rule - Design rule
See Also:
ColumnDesignModel.addDesignRule(com.cc.framework.ui.model.DesignRule)

getDesignRules

public DesignRule[] getDesignRules()
Description copied from interface: ColumnDesignModel
Returns the design rules for this column

Specified by:
getDesignRules in interface ColumnDesignModel
Returns:
Array of design rules
See Also:
ColumnDesignModel.getDesignRules()

getHandler

public java.lang.String getHandler(ClientEvent event)
Description copied from interface: ClientHandler
Returns the script handler which was associated for a client event

Specified by:
getHandler in interface ClientHandler
Overrides:
getHandler in class ClientHandlerImp
See Also:
ClientHandler.getHandler(com.cc.framework.ui.model.ClientEvent)

getTransaction

public boolean getTransaction()
Description copied from interface: ColumnDesignModel
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 ColumnDesignModel
Returns:
true if the transaction token should be generated
See Also:
ColumnDesignModel.getTransaction()

setTransaction

public void setTransaction(boolean transaction)
Description copied from interface: ColumnDesignModel
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.

Specified by:
setTransaction in interface ColumnDesignModel
Parameters:
transaction - include transaction token
See Also:
ColumnDesignModel.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)

getConverter

public Converter getConverter()
Description copied from interface: ColumnDesignModel
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!

Specified by:
getConverter in interface ColumnDesignModel
Returns:
Converter or nullSee Also:
ColumnDesignModel.getConverter()

setConverter

public void setConverter(Converter converter)
Description copied from interface: ColumnDesignModel
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!

Specified by:
setConverter in interface ColumnDesignModel
Parameters:
converter - Converters instance
See Also:
ColumnDesignModel.setConverter(com.cc.framework.convert.Converter)

getAnchor

public java.lang.String getAnchor()
Description copied from interface: ColumnDesignModel
Returns the anchor that will be appended to all Hyperlinks for this column.

Specified by:
getAnchor in interface ColumnDesignModel
Returns:
String
See Also:
ColumnDesignModel.getAnchor()

getAnchorProperty

public java.lang.String getAnchorProperty()
Description copied from interface: ColumnDesignModel
Returns the anchor property for the column.

Specified by:
getAnchorProperty in interface ColumnDesignModel
Returns:
String
See Also:
ColumnDesignModel.getAnchorProperty()

setAnchor

public void setAnchor(java.lang.String anchor)
Description copied from interface: ColumnDesignModel
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.

Specified by:
setAnchor in interface ColumnDesignModel
Parameters:
anchor - The anchor
See Also:
ColumnDesignModel.setAnchor(java.lang.String)

setAnchorProperty

public void setAnchorProperty(java.lang.String anchorProperty)
Description copied from interface: ColumnDesignModel
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.

Specified by:
setAnchorProperty in interface ColumnDesignModel
Parameters:
anchorProperty - The anchor attribute to set
See Also:
ColumnDesignModel.setAnchorProperty(java.lang.String)

getLinkName

public java.lang.String getLinkName()
Description copied from interface: ColumnDesignModel
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.

Specified by:
getLinkName in interface ColumnDesignModel
Returns:
String
See Also:
ColumnDesignModel.getLinkName()

getLinkNameProperty

public java.lang.String getLinkNameProperty()
Description copied from interface: ColumnDesignModel
Returns the anchor name property for the column.

Specified by:
getLinkNameProperty in interface ColumnDesignModel
Returns:
String
See Also:
ColumnDesignModel.getLinkNameProperty()

setLinkName

public void setLinkName(java.lang.String linkName)
Description copied from interface: ColumnDesignModel
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.

Specified by:
setLinkName in interface ColumnDesignModel
Parameters:
linkName - The link name
See Also:
ColumnDesignModel.setLinkName(java.lang.String)

setLinkNameProperty

public void setLinkNameProperty(java.lang.String linkNameProperty)
Description copied from interface: ColumnDesignModel
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.

Specified by:
setLinkNameProperty in interface ColumnDesignModel
Parameters:
linkNameProperty - The anchor name attribute to set
See Also:
ColumnDesignModel.setLinkNameProperty(java.lang.String)

getJoinMode

public JoinMode getJoinMode()
Description copied from interface: ColumnDesignModel
Returns true when the column should be joined with the previous column.

Specified by:
getJoinMode in interface ColumnDesignModel
Returns:
boolean
See Also:
ColumnDesignModel.getJoinMode()

setJoinMode

public void setJoinMode(JoinMode joinMode)
Description copied from interface: ColumnDesignModel
Set to true if the column should be joined with the previous column.

Specified by:
setJoinMode in interface ColumnDesignModel
Parameters:
joinMode - true if the column should be joined.
See Also:
ColumnDesignModel.setJoinMode(com.cc.framework.ui.JoinMode)

setJoinMode

public void setJoinMode(java.lang.String joinMode)
Joins the column with the previous column

Specified by:
setJoinMode in interface ColumnDesignModel
Parameters:
joinMode - true if the column should be joined.
See Also:
ColumnDesignModel.setJoinMode(java.lang.String)

allowAjaxRendering

public boolean allowAjaxRendering()
Description copied from interface: ColumnDesignModel
This method decides whether this column instance has enough information to be rendered as part of an AJAX response.

Specified by:
allowAjaxRendering in interface ColumnDesignModel
Returns:
returns true when the column can be rendered in an AJAX response
See Also:
ColumnDesignModel.allowAjaxRendering()


Copyright © 2000-2005 SCC Informationssysteme GmbH. All Rights Reserved.