Package org.eclnt.jsfserver.pagebean.component

Class PageBeanComponentBase

java.lang.Object

org.eclnt.jsfserver.pagebean.PageBean

org.eclnt.jsfserver.pagebean.component.PageBeanComponentBase

All Implemented Interfaces:

IPageBean, IDynamicContentBindingObject

Direct Known Subclasses:

PageBeanComponent, PageBeanComponentAsControl

public abstract class PageBeanComponentBase
extends PageBean

Base functions of a page bean component.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PageBeanComponentBase.ILiteralResolver	Interface for adding an own literal resolution.
class	PageBeanComponentBase.LitMap	Internal usage: map that lazily loads literal definitions.

Field Summary

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

m_pageModifier

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addConfiguredByLayoutListener(IConfiguredByLayoutListener listener)	See IConfiguredByLayout.addConfiguredByLayoutListener(IConfiguredByLayoutListener).
protected String	findLiteralResourceName()	Find the name of the properties-file in which the default literal resolution looks for literal translations.
protected Class	getClassDefiningPageBean()	Class that is used for accessing the layout in getLayoutPath() and the literal resources in findLiteralResourceName().
protected String	getLayoutPath()	Finds the resource path for accessing the component's layout-xml.
PageBeanComponentBase.ILiteralResolver	getLiteralResolver()	There is a default mechanism how literals of a page bean component are resolved: the component uses resource files that have the same name as the component's class.
String	getPageName()	Name of page that is managed by the bean.
void	initializePageBeanFinished()
void	initializePageBeanStarted()
boolean	isInitialized()	See IPageBean#isInitialized().
protected String	readLiteral(String key)
protected String	readLiteralByOwnResourceBundle(String key)
void	removeConfiguredByLayoutListener(IConfiguredByLayoutListener listener)	See IConfiguredByLayout.removeConfiguredByLayoutListener(IConfiguredByLayoutListener).
void	setLiteralResolver(PageBeanComponentBase.ILiteralResolver literalResolver)	Sets a literal resolver for this instance.

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

buildContentReplaceString, closePopup, getActualRootExpression, 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

Constructor Details

PageBeanComponentBase

public PageBeanComponentBase()

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

ROW
..LABEL
..
..LABEL

PageBeanComponentBase

public PageBeanComponentBase(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

initializePageBeanStarted

public void initializePageBeanStarted()

isInitialized

public boolean isInitialized()

See IPageBean#isInitialized().

getLiteralResolver

public PageBeanComponentBase.ILiteralResolver getLiteralResolver()

There is a default mechanism how literals of a page bean component are resolved: the component uses resource files that have the same name as the component's class. You may add some own literal resolved in front of this default mechanism so that you can influence all literals of the component on your own. - You may use this mechanism if you want to use different texts and/or if you want to provide for translated texts in languages that the component so far does not provide.

Please check the class PageBeanLiteralResolverOverride - here you can register literal resolvers on a class level.

setLiteralResolver

public void setLiteralResolver(PageBeanComponentBase.ILiteralResolver literalResolver)

Sets a literal resolver for this instance.

Please check the class PageBeanLiteralResolverOverride - here you can register literal resolvers on a class level.

getPageName

public String getPageName()

Description copied from interface: IPageBean

Name of page that is managed by the bean. This can either be a static return value that stays fix for the whole lifecycle of the bean, or it may also be a value that changed - in case there are several pages that are possible to be managed by the page bean.

Specified by:

getPageName in interface IPageBean

Specified by:

getPageName in class PageBean

getLayoutPath

protected String getLayoutPath()

Finds the resource path for accessing the component's layout-xml. By default the xml is contained in a jsp- or an xml-file which has the name of the component and which resides in the same package as the component.

getClassDefiningPageBean

protected Class getClassDefiningPageBean()

Class that is used for accessing the layout in getLayoutPath() and the literal resources in findLiteralResourceName().

addConfiguredByLayoutListener

public void addConfiguredByLayoutListener(IConfiguredByLayoutListener listener)

See IConfiguredByLayout.addConfiguredByLayoutListener(IConfiguredByLayoutListener).

removeConfiguredByLayoutListener

public void removeConfiguredByLayoutListener(IConfiguredByLayoutListener listener)

See IConfiguredByLayout.removeConfiguredByLayoutListener(IConfiguredByLayoutListener).

initializePageBeanFinished

public void initializePageBeanFinished()

readLiteral

protected String readLiteral(String key)

findLiteralResourceName

protected String findLiteralResourceName()

Find the name of the properties-file in which the default literal resolution looks for literal translations.

readLiteralByOwnResourceBundle

protected String readLiteralByOwnResourceBundle(String key)