Package org.eclnt.jsfserver.elements.adapter

Class ComponentAdapterBindingBase

java.lang.Object

org.eclnt.jsfserver.elements.adapter.ComponentAdapterBindingBase

All Implemented Interfaces:

Serializable, IComponentAdapterBinding, IComponentAdapterBinding2, IFIXGRIDComponentAdapterBinding, IDynamicContentBindingObject

Direct Known Subclasses:

ComponentAdapterBindingMap

public abstract class ComponentAdapterBindingBase
extends Object
implements Serializable, IComponentAdapterBinding2, IFIXGRIDComponentAdapterBinding

Base class that can (optionally) be used for implementing component adapters. The base class takes over the following functions:

(1.) It manages the set of fix and dynamic attributes. These attributes are passed at constructor point of time.
(2.) It manages the return types for the dynamic attributes.
(3.) It provides an onAction(ActionEvent) method that is called by the action listener processing. The onAction method delegates calls to listeners, implementing interface IActionListenerListener.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ComponentAdapterBindingBase(String[] fixAttributeNames, String[] dynamicAttributeNames)
ComponentAdapterBindingBase(String[] fixAttributeNames, String[] dynamicAttributeNames, Class[] dynamicAttributeTypes)

Method Summary

Modifier and Type	Method	Description
void	addActionListener(IActionListener listener)
Class	getAttibuteType(String attributeName)	This method needs only to be implemented for these attributes which are set later on.
Set<String>	getDynamicAttributeNames()	Name of the attributes that are dynamic over the whole lifecycle of the corresponding object.
Object	getExportValue()
String	getExportValueFormat()
String	getExportValueFormatmask()
String	getExportValueTimezone()
Set<String>	getFixAttributeNames()	Name of the attributes that are set one time but not changed later on anymore.
FIXGRIDBinding<?>	getGrid()	Return the grid that is managed within the adapter binding.
Object	getSortValue()	Used if adapter is used in grid column.
void	initComponent(IBaseComponent component)	This method is called when the component processing first time "touches" the component adapter binding instance.
void	onAction(javax.faces.event.ActionEvent event)	Action listener that is called when the component processes an action event.
void	removeActionListener(IActionListener listener)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclnt.jsfserver.elements.adapter.IComponentAdapterBinding

getAttributeValue, setAttributeValue

Constructor Details

ComponentAdapterBindingBase

public ComponentAdapterBindingBase(String[] fixAttributeNames,
 String[] dynamicAttributeNames)

ComponentAdapterBindingBase

public ComponentAdapterBindingBase(String[] fixAttributeNames,
 String[] dynamicAttributeNames,
 Class[] dynamicAttributeTypes)

Method Details

getDynamicAttributeNames

public Set<String> getDynamicAttributeNames()

Description copied from interface: IComponentAdapterBinding

Name of the attributes that are dynamic over the whole lifecycle of the corresponding object.

Specified by:

getDynamicAttributeNames in interface IComponentAdapterBinding

getFixAttributeNames

public Set<String> getFixAttributeNames()

Description copied from interface: IComponentAdapterBinding

Name of the attributes that are set one time but not changed later on anymore.

Specified by:

getFixAttributeNames in interface IComponentAdapterBinding

getAttibuteType

public Class getAttibuteType(String attributeName)

Description copied from interface: IComponentAdapterBinding

This method needs only to be implemented for these attributes which are set later on. It needs not to be implemented for these attributes that are "get-only". In case of returning null as type the default mechanism will be used for transferring the UI value into an object value.

Specified by:

getAttibuteType in interface IComponentAdapterBinding

onAction

public void onAction(javax.faces.event.ActionEvent event)

Description copied from interface: IComponentAdapterBinding

Action listener that is called when the component processes an action event. This action listener is called when no explicit actionListener is defined with the component.

Specified by:

onAction in interface IComponentAdapterBinding

addActionListener

public void addActionListener(IActionListener listener)

removeActionListener

public void removeActionListener(IActionListener listener)

getGrid

public FIXGRIDBinding<?> getGrid()

Description copied from interface: IFIXGRIDComponentAdapterBinding

Return the grid that is managed within the adapter binding.

Specified by:

getGrid in interface IFIXGRIDComponentAdapterBinding

initComponent

public void initComponent(IBaseComponent component)

Description copied from interface: IComponentAdapterBinding2

This method is called when the component processing first time "touches" the component adapter binding instance. By passing the component, the adapter binding can directly react and adapt its behavior.

Example the edit-able value behind a component is kept in different attributes, dependent on the control (FIELD-TEXT, COMBOFIELD-VALUE, CHECKBOX-SELECTED).

Specified by:

initComponent in interface IComponentAdapterBinding2

getSortValue

public Object getSortValue()

Used if adapter is used in grid column. In this case the sorting uses this method to retrieve the value to sort for. Default implementation: check for value in default properties "text", "value", "selected"

getExportValue

public Object getExportValue()

getExportValueFormat

public String getExportValueFormat()

getExportValueFormatmask

public String getExportValueFormatmask()

getExportValueTimezone

public String getExportValueTimezone()