Package org.eclnt.jsfserver.pagebean.componentascontrol

Class PageBeanComponentAsControl

java.lang.Object

org.eclnt.jsfserver.pagebean.PageBean

org.eclnt.jsfserver.pagebean.component.PageBeanComponentBase

org.eclnt.jsfserver.pagebean.componentascontrol.PageBeanComponentAsControl

All Implemented Interfaces:

IConfiguredByLayout, IPageBeanComponentAsControl, IPageBean, IDynamicContentBindingObject

Direct Known Subclasses:

PageBeanComponentAsControlWithAction

public abstract class PageBeanComponentAsControl
extends PageBeanComponentBase
implements IPageBeanComponentAsControl

Self containing component that can be easily re-used across application projects.

The aspects of "self containing" include:

The .jsp layout definition is contained in the same package than this class. As consequence the .jsp layout is part of the ".jar-delivery" and does not need to be installed as additional web content.

The literals that are required are contained in a properties file that has the same name as the class and that is contained in the same package.

There is a configuration file ".config" that describes the component.

Example: the complete component definition of a XyzPageBean consists out of:
1. XyzPageBean.java in the source package
2. XyzPageBean.jsp in the resource package
3. XyzPageBean.properties in the resource package (and additional language definitions)
4. XyzPageBean.config in the resource package

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PageBeanComponentAsControl.ILiteralResolver
class	PageBeanComponentAsControl.LitMap

Field Summary

Fields inherited from class org.eclnt.jsfserver.pagebean.PageBean

m_pageModifier

Constructor Summary

Constructors

Constructor	Description
PageBeanComponentAsControl()	Default constructor, the component is used as "column control".
PageBeanComponentAsControl(boolean usedAsRow)	Constructor, in which you can decide to use the component as "row control".

Method Summary

Modifier and Type	Method	Description
PageBeanComponentAsControl.LitMap	getLit()	Access to literal map from outside.
void	initializePageBean(Map<String,String> fixParams, Map<String,IValueDelegation<?>> dynParams)	Pass initialization parameters from JSP definition into the page bean.
void	initializePageBeanConfigItems(List<PageBeanComponentAsControlConfigItem> configItems)	Pass initialization configuration items from JSP definition into the page bean.
protected void	transferAttributeReferencesIntoPageBeanInstance(Object o, Map<String,String> fixParams, Map<String,IValueDelegation<?>> dynParams)

Methods inherited from class org.eclnt.jsfserver.pagebean.component.PageBeanComponentBase

addConfiguredByLayoutListener, findLiteralResourceName, getClassDefiningPageBean, getLayoutPath, getLiteralResolver, getPageName, initializePageBeanFinished, initializePageBeanPassComponent, initializePageBeanStarted, isInitialized, readLiteral, readLiteralByOwnResourceBundle, removeConfiguredByLayoutListener, setLiteralResolver

Methods inherited from class org.eclnt.jsfserver.pagebean.PageBean

buildContentReplaceString, closePopup, getActualRootExpression, getModalModelessPopupForPopupPageBean, getPageModifier, getPopups, getRootExpressionUsedInPage, getStamp, initializePageModifier, onBeforeRendering, openModalPopup, openModelessPopup, pbx, readPageLayoutXML, setActualRootExpression

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

addConfiguredByLayoutListener, removeConfiguredByLayoutListener

Methods inherited from interface org.eclnt.jsfserver.pagebean.IPageBean

closePopup, getActualRootExpression, getPageModifier, getPageName, getRootExpressionUsedInPage, getStamp, onBeforeRendering, openModalPopup, openModelessPopup, setActualRootExpression

Methods inherited from interface org.eclnt.jsfserver.pagebean.componentascontrol.IPageBeanComponentAsControl

initializePageBeanFinished, initializePageBeanPassComponent, initializePageBeanStarted, isInitialized

Constructor Details

PageBeanComponentAsControl

public PageBeanComponentAsControl()

Default constructor, the component is used as "column control". A typical component arrangement would be:

ROW
..LABEL
..
..LABEL

PageBeanComponentAsControl

public PageBeanComponentAsControl(boolean usedAsRow)

Constructor, in which you can decide to use the component as "row control". A typical arrangement would be.

ROWBODyPANE
..ROW
..
..ROW


Another tpyical use case: you want to use the component within a modal or modeless dialog. Dialogs expects contained page beans to be row controls.

Method Details

getLit

public PageBeanComponentAsControl.LitMap getLit()

Access to literal map from outside.

initializePageBean

public void initializePageBean(Map<String,String> fixParams,
 Map<String,IValueDelegation<?>> dynParams)

Description copied from interface: IPageBeanComponentAsControl

Pass initialization parameters from JSP definition into the page bean.

Specified by:

initializePageBean in interface IPageBeanComponentAsControl

initializePageBeanConfigItems

public void initializePageBeanConfigItems(List<PageBeanComponentAsControlConfigItem> configItems)

Description copied from interface: IPageBeanComponentAsControl

Pass initialization configuration items from JSP definition into the page bean.

Specified by:

initializePageBeanConfigItems in interface IPageBeanComponentAsControl

transferAttributeReferencesIntoPageBeanInstance

protected void transferAttributeReferencesIntoPageBeanInstance(Object o,
 Map<String,String> fixParams,
 Map<String,IValueDelegation<?>> dynParams)