no.g9.client.core.view.faces

Class FacesApplicationBean

java.lang.Object

no.g9.client.core.view.faces.FacesApplicationBean

public abstract class FacesApplicationBean
extends Object

The superclass for the JSF backing bean of the application.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FacesApplicationBean() Note that this constructor should not normally be used, it is only to satisfy the Serializable interface of its subclasses.
	FacesApplicationBean(String applicationBeanName, FacesApplicationView applicationView) Create a new application backing bean, and setting the references between the bean and the application view.

Method Summary

Modifier and Type	Method and Description
protected abstract String[]	buildDialogBoxIncludePaths() Build the JSF facelet dynamic include paths for the dialog boxes.
protected abstract String	buildDialogIncludePath() Build the JSF facelet dynamic include path for the current dialog.
protected abstract String	buildDialogToolbarIncludePath() Build the JSF facelet dynamic include path for the toolbar of the current dialog.
FacesApplicationView	getApplicationView()
static FacesApplicationBean	getCurrentApplicationBean() Find the current instance of the FacesApplicationBean for the JSF context of this application.
String[]	getDialogBoxIncludePaths() Get the JSF facelet dynamic include paths for the dialog boxes.
String	getDialogIncludePath() Get the JSF facelet dynamic include path for the current dialog.
String	getDialogTitle(DialogInstance instance) Get the title for the given dialog instance.
protected String	getDialogToolbarIncludePath() Get the JSF facelet dynamic include path for the toolbar of the current dialog.
static <T> T	getFacesBean(String beanName) Get the named JSF managed bean from the JSF context.
String	getFacesMessage(String bundleName, String key) Get the JSF message from the message bundle.
String	getMessageBoxAltText()
protected String	getMessageBoxButtonId(no.g9.message.MessageReplyType reply) Get the JSF ID of the message box button for the given reply type.
String	getMessageBoxFocusButton()
String	getMessageBoxIcon()
String	getMessageBoxTitle() Get the message box title.
String	getMessageInput()
String	getMessageText()
int	getNumberOfOpenDialogBoxes()
boolean	getShowMessage()
boolean	getShowMessageAbortButton()
boolean	getShowMessageCancelButton()
boolean	getShowMessageIgnoreButton()
boolean	getShowMessageInput()
boolean	getShowMessageNoButton()
boolean	getShowMessageOkButton()
boolean	getShowMessageRetryButton()
boolean	getShowMessageYesButton()
void	messageBox_AbortClicked(javax.faces.event.ActionEvent event) The event handler for the message box Abort button.
void	messageBox_CancelClicked(javax.faces.event.ActionEvent event) The event handler for the message box Cancel button.
void	messageBox_CloseClicked(org.icefaces.ace.event.CloseEvent event) The event handler for the message box Close button.
void	messageBox_IgnoreClicked(javax.faces.event.ActionEvent event) The event handler for the message box Ignore button.
void	messageBox_NoClicked(javax.faces.event.ActionEvent event) The event handler for the message box No button.
void	messageBox_OkClicked(javax.faces.event.ActionEvent event) The event handler for the message box OK button.
void	messageBox_RetryClicked(javax.faces.event.ActionEvent event) The event handler for the message box Retry button.
void	messageBox_YesClicked(javax.faces.event.ActionEvent event) The event handler for the message box Yes button.
String	msg(String key) Get the message text for the given key.
void	setApplicationView(FacesApplicationView applicationView) Set the JSF application view.
static void	setExternalResourceProvider(no.g9.support.ResourceProvider<String> resourceProvider) Sets an external resource provider.
void	setMessageInput(String messageInput) Set the message input string (the reply string).
void	setShowMessage(boolean on) Dummy setter for JSF.

Methods inherited from class java.lang.Object

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

Constructor Detail

FacesApplicationBean

public FacesApplicationBean(String applicationBeanName,
                            FacesApplicationView applicationView)

Create a new application backing bean, and setting the references between the bean and the application view.

Parameters:

applicationBeanName - the name of the JSF application bean

applicationView - the JSF application view

FacesApplicationBean

protected FacesApplicationBean()

Note that this constructor should not normally be used, it is only to satisfy the Serializable interface of its subclasses.

Method Detail

getApplicationView

public FacesApplicationView getApplicationView()

Returns:

the JSF application view.

setApplicationView

public void setApplicationView(FacesApplicationView applicationView)

Set the JSF application view.

Parameters:

applicationView - the new JSF application view

getFacesMessage

public String getFacesMessage(String bundleName,
                              String key)

Get the JSF message from the message bundle.

Parameters:

bundleName - - the JSF message file name, null if default bundle

key - - the lookup key

Returns:

the found message string, or an error string if not found

msg

public String msg(String key)

Get the message text for the given key. The default is to look for the message in the generated messages.properties file for the application. This method is used from the generated xhtml markup, to allow for providing other message sources than the default resource bundle.

Parameters:

key - the message key for the message

Returns:

the message text for the given key

getDialogIncludePath

public String getDialogIncludePath()

Get the JSF facelet dynamic include path for the current dialog.

Returns:

the dynamic include path for the current dialog

getNumberOfOpenDialogBoxes

public int getNumberOfOpenDialogBoxes()

Returns:

the number of open dialog boxes in the application

getDialogBoxIncludePaths

public String[] getDialogBoxIncludePaths()

Get the JSF facelet dynamic include paths for the dialog boxes.

Returns:

the dynamic include paths for the dialog boxes

getDialogToolbarIncludePath

protected String getDialogToolbarIncludePath()

Get the JSF facelet dynamic include path for the toolbar of the current dialog.

Returns:

the dynamic include path for the current dialog toolbar

buildDialogIncludePath

protected abstract String buildDialogIncludePath()

Build the JSF facelet dynamic include path for the current dialog.

Returns:

the dynamic include path

buildDialogBoxIncludePaths

protected abstract String[] buildDialogBoxIncludePaths()

Build the JSF facelet dynamic include paths for the dialog boxes.

Returns:

the dynamic include paths

buildDialogToolbarIncludePath

protected abstract String buildDialogToolbarIncludePath()

Build the JSF facelet dynamic include path for the toolbar of the current dialog.

Returns:

the dynamic include path

messageBox_CloseClicked

public void messageBox_CloseClicked(org.icefaces.ace.event.CloseEvent event)

The event handler for the message box Close button.

Parameters:

event - the JSF event

messageBox_OkClicked

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

The event handler for the message box OK button.

Parameters:

event - the JSF event

messageBox_YesClicked

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

The event handler for the message box Yes button.

Parameters:

event - the JSF event

messageBox_NoClicked

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

The event handler for the message box No button.

Parameters:

event - the JSF event

messageBox_CancelClicked

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

The event handler for the message box Cancel button.

Parameters:

event - the JSF event

messageBox_AbortClicked

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

The event handler for the message box Abort button.

Parameters:

event - the JSF event

messageBox_RetryClicked

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

The event handler for the message box Retry button.

Parameters:

event - the JSF event

messageBox_IgnoreClicked

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

The event handler for the message box Ignore button.

Parameters:

event - the JSF event

getShowMessage

public boolean getShowMessage()

Returns:

true if a message should be shown, false otherwise

setShowMessage

public void setShowMessage(boolean on)

Dummy setter for JSF.

Parameters:

on - ignored

getMessageBoxTitle

public String getMessageBoxTitle()

Get the message box title. If the message has a title, it will be used. If not, the application title is used.

Returns:

the title for the message box

getMessageBoxIcon

public String getMessageBoxIcon()

Returns:

the URL for the message box icon

getMessageBoxAltText

public String getMessageBoxAltText()

Returns:

the Alt text for the message box icon

getMessageText

public String getMessageText()

Returns:

the message text if there is a current message, null otherwise

getShowMessageInput

public boolean getShowMessageInput()

Returns:

true if the message input field is to be shown

getShowMessageOkButton

public boolean getShowMessageOkButton()

Returns:

true if the message ok button is to be shown

getShowMessageYesButton

public boolean getShowMessageYesButton()

Returns:

true if the message yes button is to be shown

getShowMessageNoButton

public boolean getShowMessageNoButton()

Returns:

true if the message no button is to be shown

getShowMessageCancelButton

public boolean getShowMessageCancelButton()

Returns:

true if the message cancel button is to be shown

getShowMessageAbortButton

public boolean getShowMessageAbortButton()

Returns:

true if the message abort button is to be shown

getShowMessageRetryButton

public boolean getShowMessageRetryButton()

Returns:

true if the message retry button is to be shown

getShowMessageIgnoreButton

public boolean getShowMessageIgnoreButton()

Returns:

true if the message ignore button is to be shown

getMessageInput

public String getMessageInput()

Returns:

the message input string

setMessageInput

public void setMessageInput(String messageInput)

Set the message input string (the reply string).

Parameters:

messageInput - the new message input string

getMessageBoxFocusButton

public String getMessageBoxFocusButton()

Returns:

the JSF ID of the message box button to receive initial focus

getMessageBoxButtonId

protected String getMessageBoxButtonId(no.g9.message.MessageReplyType reply)

Get the JSF ID of the message box button for the given reply type.

Parameters:

reply - the reply type corresponding to the button

Returns:

the JSF ID of the button

getDialogTitle

public String getDialogTitle(DialogInstance instance)

Get the title for the given dialog instance.

Parameters:

instance - the dialog instance in question

Returns:

the title for the instance

getFacesBean

public static <T> T getFacesBean(String beanName)

Get the named JSF managed bean from the JSF context.

Type Parameters:

T - the bean class

Parameters:

beanName - the name of the managed bean

Returns:

the bean

getCurrentApplicationBean

public static FacesApplicationBean getCurrentApplicationBean()

Find the current instance of the FacesApplicationBean for the JSF context of this application. The name of the application bean is expected to be set from the first instance of the application bean, and this method throws an IllegalStateException if called before the name is set.

Returns:

the current application bean instance

setExternalResourceProvider

public static void setExternalResourceProvider(no.g9.support.ResourceProvider<String> resourceProvider)

Sets an external resource provider. This resource provider is checked first, before the generated ResourceBundles are used when looking for resource texts.

Parameters:

resourceProvider - New resource provider (or null, to erase)