com.sdm.quasar.client.jsf.dialog.features
Class BrowserWindowCompositeFeature

java.lang.Object
  com.sdm.quasar.client.core.dialog.AbstractFeature
      com.sdm.quasar.client.jsf.dialog.features.BrowserWindowCompositeFeature

All Implemented Interfaces:

Feature, SystemInfoProvider

public class BrowserWindowCompositeFeature

extends AbstractFeature

The BrowserWindowCompositeFeature manages the visibility of the VisualRepresentation in the BrowserWindow using the BrowserWindowService as follows: The VisualRepresentation is shown when the dialog is activated and it is hidden, when the dialog is deactivated. If no VisualRepresentation is supported it is created by the BrowserWindowCompositeFeature. Here the strategy of showing and hiding the VisualRepresentation can be configurated in the dialog configuration file. The BrowserWindow provides two different showing strategies and four hiding strategies concerning the browser navigation. These are configurable for the dialog by dialog properties

• A dialog instance is shown modal if the property {@value} has value Boolean.TRUE. Default is not modal. Use modal with care!
• A dialog instance is hidden an never shown again if the property {@value} has value Boolean.FALSE. Else on backnavigation to this dialog a new instance of the same dialog will be created and shown. That's the default.
• A dialog instance is replaced by an other dialog if the property #REPLACING_DIALOG_KEYWORD is set. The value defines the dialog id of the dialog to be created and shown instead.
• A dialog instance is replaced by a page if the property #REPLACING_URL_KEYWORD is set. The value defines url of the page to be shown instead.

Use other strategies except the default carefully.

Author:

Martin Haft

Constructor Summary

BrowserWindowCompositeFeature()

Method Summary

protected void	activate() Called when the dialog is activated.
protected void	deactivate() Called when the dialog is deactivated.
protected void	dispose() Called when the feature or dialog is disposed.
java.util.Properties	getBookmarks()
protected BrowserWindowService	getBrowserWindowService()
java.lang.String	getReplacingDialog()
java.lang.Object	getReplacingDialogContext()
java.lang.String	getReplacingUrl()
VisualRepresentation	getVisualRepresentation() If no VisualRepresentation is set, it is created with configured parameters.
protected void	init() Called when the feature is initializing.
boolean	isModal()
boolean	isRecreate()
protected void	prepare() Called when the dialog is prepared.
void	setBookmarks(java.util.Properties parameters) Set the bookmark parameters.
void	setModal(boolean isModal)
void	setPresentationURI(java.lang.String presentationURI) Set the url of the VisualRepresentation
void	setRecreate(boolean recreate)
void	setReplacingDialog(java.lang.String replacingDialog)
void	setReplacingDialogContext(java.lang.Object replacingDialogContext)
void	setReplacingUrl(java.lang.String replacingUrl)
void	setVisualRepresentation(VisualRepresentation visRep) Set a VisualRepresentation

Methods inherited from class com.sdm.quasar.client.core.dialog.AbstractFeature

attachDialogControl, collectSystemInfo, disposeFeature, getDialogControl, isInitialized, release

Methods inherited from class java.lang.Object

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

Constructor Detail

BrowserWindowCompositeFeature

public BrowserWindowCompositeFeature()

Method Detail

dispose

protected void dispose()
                throws DisposeException

Description copied from class: AbstractFeature

Called when the feature or dialog is disposed. Override this method to clean up resources and free memory when disposing.

Specified by:

dispose in class AbstractFeature

Throws:

DisposeException

init

protected void init()

Description copied from class: AbstractFeature

Called when the feature is initializing. This is normally done, when the feature is connected to the lifecycle of the DialogControl installed to. To access the DialogControl use the AbstractFeature.getDialogControl() method.

Override this method to perform some action on initialization e.g. register public services.

Specified by:

init in class AbstractFeature

prepare

protected void prepare()

Description copied from class: AbstractFeature

Called when the dialog is prepared. Override this method if you want to perform some action on LifeCycle.prepare(), e.g. gain resource and provide services for childs.

The default implementation in AbstractFeature does nothing.

Overrides:

prepare in class AbstractFeature

activate

protected void activate()

Description copied from class: AbstractFeature

Called when the dialog is activated. Override this method if you want to perform some action on LifeCycle.activate().

The default implementation in AbstractFeature does nothing.

Overrides:

activate in class AbstractFeature

deactivate

protected void deactivate()

Description copied from class: AbstractFeature

Called when the dialog is deactivated. Override this method if you want to perform some action on LifeCycle.deactivate()().

The default implementation in AbstractFeature does nothing.

Overrides:

deactivate in class AbstractFeature

getBrowserWindowService

protected BrowserWindowService getBrowserWindowService()

getVisualRepresentation

public VisualRepresentation getVisualRepresentation()

If no VisualRepresentation is set, it is created with configured parameters.

Returns:

the VisualRepresentation of the dialog

setVisualRepresentation

public void setVisualRepresentation(VisualRepresentation visRep)

Set a VisualRepresentation

Parameters:

visRep - the VisualRepresentation to set

setPresentationURI

public void setPresentationURI(java.lang.String presentationURI)

Set the url of the VisualRepresentation

Parameters:

presentationURI - the url of the VisualRepresentation

getBookmarks

public java.util.Properties getBookmarks()

Returns:

the set bookmark parameters or null

setBookmarks

public void setBookmarks(java.util.Properties parameters)

Set the bookmark parameters.

Parameters:

parameters - Bookmark parameters of the VisualRepresentation

isModal

public boolean isModal()

setModal

public void setModal(boolean isModal)

isRecreate

public boolean isRecreate()

Returns:

the recreate

setRecreate

public void setRecreate(boolean recreate)

Parameters:

recreate - the recreate to set

getReplacingDialog

public java.lang.String getReplacingDialog()

Returns:

the replacingDialog

setReplacingDialog

public void setReplacingDialog(java.lang.String replacingDialog)

Parameters:

replacingDialog - the replacingDialog to set

getReplacingUrl

public java.lang.String getReplacingUrl()

Returns:

the replacingUrl

setReplacingUrl

public void setReplacingUrl(java.lang.String replacingUrl)

Parameters:

replacingUrl - the replacingUrl to set

getReplacingDialogContext

public java.lang.Object getReplacingDialogContext()

Returns:

the replacingDialogContext

setReplacingDialogContext

public void setReplacingDialogContext(java.lang.Object replacingDialogContext)

Parameters:

replacingDialogContext - the replacingDialogContext to set