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

java.lang.Object
  extended bycom.cc.framework.ui.model.imp.ClientHandlerImp
      extended bycom.cc.framework.ui.model.imp.ColumnDesignModelImp
          extended bycom.cc.framework.ui.model.imp.ColumnSelectDesignModelImp
All Implemented Interfaces:
AccessControlled, ActionBehavior, AjaxSupport, ClientHandler, ColumnDesignModel, ColumnSelectDesignModel, DesignModel, OptionListDesignModel, java.io.Serializable

public class ColumnSelectDesignModelImp
extends ColumnDesignModelImp
implements ColumnSelectDesignModel

Design Model implementation for the select column

Version:
$Revision: 1.19 $
Author:
Harald Schulz
See Also:
Serialized Form

Field Summary
private  DeferredValue empty
          An optional text to prompt the user for selecting an option of the list.
private  DeferredValue keyProperty
          The property for the key
private  DeferredValue labelProperty
          The property for the label
private  boolean localize
          Specifies if all String should be treated as Resource Identifiers and must be localized
private  boolean multiple
          Indicates that multiple selections is allowed.
private  DeferredValue optionsProperty
          Property for retrieving a individual option list for each row bean
private static long serialVersionUID
          Serial Version UID
private  java.lang.Object sharedOptions
          A option list that is shared among all row beans
private  boolean showRoot
          Shows or hides the root of a TreeNodeDatamodel option list
private  DeferredValue size
          Number of character positions to allocate.
 
Fields inherited from class com.cc.framework.ui.model.imp.ColumnDesignModelImp
 
Fields inherited from class com.cc.framework.ui.model.imp.ClientHandlerImp
 
Constructor Summary
ColumnSelectDesignModelImp()
           
 
Method Summary
 java.lang.String getEmpty()
          Returns the label of an additional empty-entry
 java.lang.String getKeyProperty()
          Returns the name of the property which returns the key of the option.
 java.lang.String getLabelProperty()
          Returns the name of the property which supplies the display text of the option.
 java.lang.String getOptionsProperty()
          Returns the name of the property which returns the individual OptionListDataModel for each row of the list
 java.lang.Object getSharedOptions()
          Returns the OptionListDataModel that is shared among all rows of the list
 int getSize()
          Returns the number of visible characters for an input/text field.
 boolean isMultiple()
          Indicates that multiple selections is allowed.
 boolean localize()
          If this flag is set to true the framework interprets all labels as resource identifiers and localize them.
 void setEmpty(java.lang.String empty)
          Sets the label of an additional empty-entry
 void setKeyProperty(java.lang.String keyProperty)
          Sets the name of the property which returns the key of the option.
 void setLabelProperty(java.lang.String labelProperty)
          Sets the name of the property which supplies the display text of the option.
 void setLocalize(boolean localize)
          If this flag is set to true the framework interprets all labels as resource identifiers and localize them.
 void setMultiple(boolean multiple)
          Indicates that multiple selections is allowed.
 void setOptionsProperty(java.lang.String property)
          Specifies the name of the property which returns the OptionListDataModel
 void setSharedOptions(java.lang.Object elements)
          Sets a option list that is shared among all rows of the list
 void setSize(int size)
          Sets the size of the input field.
 void setSize(java.lang.String size)
          Sets the size of the input field.
 boolean showRoot()
          Returns if the root element should be displayed (for TreeDataModel options)
 void showRoot(boolean show)
          Specifies whether the root of the tree element should be displayed (for TreeDataModel options).
 
Methods inherited from class com.cc.framework.ui.model.imp.ColumnDesignModelImp
addDesignRule, allowAjaxRendering, enableAjax, filter, getAlignment, getAnchor, getAnchorProperty, getConverter, getDesignRules, getDisableProperty, getEditableProperty, getEnableProperty, getEnvironment, getHandler, getHeader, getImageMap, getImageProperty, getJoinMode, getLinkName, getLinkNameProperty, getMaxLength, getPermission, getProperty, getRunAt, getStyle, getStyleClass, getStyleId, getTarget, getTargetProperty, getTitle, getTooltip, getTooltipProperty, getTransaction, getType, getWidth, isAjaxEnabled, isDisabled, isEditable, isSortable, setAlignment, setAlignment, setAnchor, setAnchorProperty, setConverter, setDisabled, setDisabled, setDisableProperty, setEditable, setEditable, setEditableProperty, setEnableProperty, setEnvironment, setFilter, setFilter, setHeader, setImageMap, setImageProperty, setJoinMode, setJoinMode, setLinkName, setLinkNameProperty, setMaxLength, setMaxLength, setPermission, setPermission, setProperty, setRunAt, setSortable, setStyle, setStyleClass, setStyleId, setTarget, setTargetProperty, setTitle, setTooltip, setTooltipProperty, setTransaction, setType, setWidth, setWidth, show
 
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.ColumnDesignModel
addDesignRule, allowAjaxRendering, filter, getAlignment, getAnchor, getAnchorProperty, getConverter, getDesignRules, getDisableProperty, getEditableProperty, getEnableProperty, getEnvironment, getHeader, getImageMap, getImageProperty, getJoinMode, getLinkName, getLinkNameProperty, getMaxLength, getProperty, getRunAt, getStyle, getStyleClass, getStyleId, getTarget, getTargetProperty, getTitle, getTooltip, getTooltipProperty, getTransaction, getType, getWidth, isDisabled, isEditable, isSortable, setAlignment, setAlignment, setAnchor, setAnchorProperty, setConverter, setDisabled, setDisabled, setDisableProperty, setEditable, setEditable, setEditableProperty, setEnableProperty, setEnvironment, setFilter, setFilter, setHeader, setImageMap, setImageProperty, setJoinMode, setJoinMode, setLinkName, setLinkNameProperty, setMaxLength, setMaxLength, setPermission, setPermission, setProperty, setRunAt, setSortable, setStyle, setStyleClass, setStyleId, setTarget, setTargetProperty, setTitle, setTooltip, setTooltipProperty, setTransaction, setType, setWidth, setWidth
 
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
 
Methods inherited from interface com.cc.framework.ui.model.OptionListDesignModel
filter, getImageMap, getMaxLength, getProperty, getStyle, getStyleClass, getTooltipProperty, setFilter, setImageMap, setMaxLength, setProperty, setStyle, setStyleClass, setTooltipProperty
 

Field Detail

serialVersionUID

private static final long serialVersionUID
Serial Version UID

See Also:
Constant Field Values

multiple

private boolean multiple
Indicates that multiple selections is allowed.


keyProperty

private DeferredValue keyProperty
The property for the key


labelProperty

private DeferredValue labelProperty
The property for the label


optionsProperty

private DeferredValue optionsProperty
Property for retrieving a individual option list for each row bean


sharedOptions

private java.lang.Object sharedOptions
A option list that is shared among all row beans


empty

private DeferredValue empty
An optional text to prompt the user for selecting an option of the list. Something like ""


size

private DeferredValue size
Number of character positions to allocate.


showRoot

private boolean showRoot
Shows or hides the root of a TreeNodeDatamodel option list


localize

private boolean localize
Specifies if all String should be treated as Resource Identifiers and must be localized

Constructor Detail

ColumnSelectDesignModelImp

public ColumnSelectDesignModelImp()
Method Detail

getEmpty

public java.lang.String getEmpty()
Description copied from interface: OptionListDesignModel
Returns the label of an additional empty-entry

Specified by:
getEmpty in interface OptionListDesignModel
Returns:
Label for the additional empty-entry
See Also:
OptionListDesignModel.getEmpty()

getOptionsProperty

public java.lang.String getOptionsProperty()
Description copied from interface: ColumnSelectDesignModel
Returns the name of the property which returns the individual OptionListDataModel for each row of the list

Specified by:
getOptionsProperty in interface ColumnSelectDesignModel
Returns:
The name of the property
See Also:
ColumnSelectDesignModel.getOptionsProperty()

setEmpty

public void setEmpty(java.lang.String empty)
Description copied from interface: OptionListDesignModel
Sets the label of an additional empty-entry

Specified by:
setEmpty in interface OptionListDesignModel
Parameters:
empty - Label for the additional empty-entry
See Also:
OptionListDesignModel.setEmpty(java.lang.String)

setOptionsProperty

public void setOptionsProperty(java.lang.String property)
Description copied from interface: ColumnSelectDesignModel
Specifies the name of the property which returns the OptionListDataModel

Specified by:
setOptionsProperty in interface ColumnSelectDesignModel
Parameters:
property - The name of the property
See Also:
ColumnSelectDesignModel.setOptionsProperty(java.lang.String)

setSharedOptions

public void setSharedOptions(java.lang.Object elements)
Description copied from interface: ColumnSelectDesignModel
Sets a option list that is shared among all rows of the list

Specified by:
setSharedOptions in interface ColumnSelectDesignModel
Parameters:
elements - The Option elements
See Also:
ColumnSelectDesignModel.setSharedOptions(java.lang.Object)

getSharedOptions

public java.lang.Object getSharedOptions()
Description copied from interface: ColumnSelectDesignModel
Returns the OptionListDataModel that is shared among all rows of the list

Specified by:
getSharedOptions in interface ColumnSelectDesignModel
Returns:
Option elements
See Also:
ColumnSelectDesignModel.getSharedOptions()

getKeyProperty

public java.lang.String getKeyProperty()
Description copied from interface: OptionListDesignModel
Returns the name of the property which returns the key of the option.

Specified by:
getKeyProperty in interface OptionListDesignModel
Returns:
Name of the property
See Also:
OptionListDesignModel.getKeyProperty()

getLabelProperty

public java.lang.String getLabelProperty()
Description copied from interface: OptionListDesignModel
Returns the name of the property which supplies the display text of the option.

Specified by:
getLabelProperty in interface OptionListDesignModel
Returns:
Name of the property
See Also:
OptionListDesignModel.getLabelProperty()

setKeyProperty

public void setKeyProperty(java.lang.String keyProperty)
Description copied from interface: OptionListDesignModel
Sets the name of the property which returns the key of the option.

Specified by:
setKeyProperty in interface OptionListDesignModel
Parameters:
keyProperty - Name of the property
See Also:
OptionListDesignModel.setKeyProperty(java.lang.String)

setLabelProperty

public void setLabelProperty(java.lang.String labelProperty)
Description copied from interface: OptionListDesignModel
Sets the name of the property which supplies the display text of the option.

Specified by:
setLabelProperty in interface OptionListDesignModel
Parameters:
labelProperty - Name of the property
See Also:
OptionListDesignModel.setLabelProperty(java.lang.String)

getSize

public int getSize()
Description copied from interface: ColumnSelectDesignModel
Returns the number of visible characters for an input/text field.

Specified by:
getSize in interface ColumnSelectDesignModel
Returns:
Number of character positions to allocate
See Also:
ColumnSelectDesignModel.getSize()

isMultiple

public boolean isMultiple()
Description copied from interface: ColumnSelectDesignModel
Indicates that multiple selections is allowed.

Specified by:
isMultiple in interface ColumnSelectDesignModel
Returns:
returns true for a multiple selection control
See Also:
ColumnSelectDesignModel.isMultiple()

setMultiple

public void setMultiple(boolean multiple)
Description copied from interface: ColumnSelectDesignModel
Indicates that multiple selections is allowed.

Specified by:
setMultiple in interface ColumnSelectDesignModel
Parameters:
multiple - for multiple selection
See Also:
ColumnSelectDesignModel.setMultiple(boolean)

setSize

public void setSize(int size)
Description copied from interface: ColumnSelectDesignModel
Sets the size of the input field.

Specified by:
setSize in interface ColumnSelectDesignModel
Parameters:
size - The size of the input field.
See Also:
ColumnSelectDesignModel.setSize(int)

setSize

public void setSize(java.lang.String size)
Description copied from interface: ColumnSelectDesignModel
Sets the size of the input field.

Specified by:
setSize in interface ColumnSelectDesignModel
Parameters:
size - The size of the input field.
See Also:
ColumnSelectDesignModel.setSize(java.lang.String)

localize

public boolean localize()
Description copied from interface: OptionListDesignModel
If this flag is set to true the framework interprets all labels as resource identifiers and localize them. If the flag is set to false the labels are treated as string literals without localization.

Specified by:
localize in interface OptionListDesignModel
Returns:
true if all labels should be localized
See Also:
OptionListDesignModel.localize()

setLocalize

public void setLocalize(boolean localize)
Description copied from interface: OptionListDesignModel
If this flag is set to true the framework interprets all labels as resource identifiers and localize them. If the flag is set to false the labels are treated as string literals without localization.

Specified by:
setLocalize in interface OptionListDesignModel
Parameters:
localize - Localization setting for the option list
See Also:
OptionListDesignModel.setLocalize(boolean)

showRoot

public boolean showRoot()
Description copied from interface: OptionListDesignModel
Returns if the root element should be displayed (for TreeDataModel options)

Specified by:
showRoot in interface OptionListDesignModel
Returns:
boolean true if the root element should be displayed; false otherwise
See Also:
OptionListDesignModel.showRoot()

showRoot

public void showRoot(boolean show)
Description copied from interface: OptionListDesignModel
Specifies whether the root of the tree element should be displayed (for TreeDataModel options).

Specified by:
showRoot in interface OptionListDesignModel
Parameters:
show - true if the root element should be displayed
See Also:
OptionListDesignModel.showRoot(boolean)


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