org.apache.myfaces.custom.ppr
Class PPRPanelGroup

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIPanel
              javax.faces.component.html.HtmlPanelGroup
                  org.apache.myfaces.component.html.ext.AbstractHtmlPanelGroup
                      org.apache.myfaces.component.html.ext.HtmlPanelGroup
                          org.apache.myfaces.custom.ppr.AbstractPPRPanelGroup
                              org.apache.myfaces.custom.ppr.PPRPanelGroup

All Implemented Interfaces:

javax.faces.component.StateHolder, org.apache.myfaces.component.DisplayValueOnlyAware, org.apache.myfaces.component.EventAware, org.apache.myfaces.component.ForceIdAware, org.apache.myfaces.component.UniversalProperties, org.apache.myfaces.component.UserRoleAware, org.apache.myfaces.shared_tomahawk.component.DisplayValueOnlyCapable

public class PPRPanelGroup
extends AbstractPPRPanelGroup

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	DEFAULT_RENDERER_TYPE

Fields inherited from class org.apache.myfaces.component.html.ext.AbstractHtmlPanelGroup

BLOCK_LAYOUT, DEFAULT_COLSPAN

Fields inherited from interface org.apache.myfaces.component.UserRoleAware

ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR

Fields inherited from interface org.apache.myfaces.shared_tomahawk.component.DisplayValueOnlyCapable

DISPLAY_VALUE_ONLY_ATTR, DISPLAY_VALUE_ONLY_STYLE_ATTR, DISPLAY_VALUE_ONLY_STYLE_CLASS_ATTR

Constructor Summary

PPRPanelGroup()

Method Summary

java.lang.String	getAfterUpdateJSHook() Javascript code executed after a ppr update has been completed
java.lang.String	getAppendMessages() comma separated List of client Ids that specify the messages components in the page to which messages are appended by this PPRPanelGroup
java.lang.String	getComponentUpdateFunction() client javascript function which will do the actual dom update.
java.lang.String	getExcludeFromStoppingPeriodicalUpdate() Normally when a link is clicked during periodical update, the update is stopped in order to prevent the server from getting unexpected requests.
java.lang.String	getFamily()
java.lang.String	getInlineLoadingMessage() If this attribute is set the content of the PPRPanelGroup will be replaced by the provided Loading-Message during partial update
java.lang.String	getPartialTriggerPattern() Regular Expression If the client Id of a submitting Component matches this Pattern the corresponding pprPanelGroup is updated via AJAX
java.lang.String	getPartialTriggers() Comma or Space seperated List of ids from ui_command-items which trigger a partial update of this PanelGroup
java.lang.String	getPeriodicalTriggers() If a periodicalUpdate is set this trigger starts the periodical requests.
java.lang.Integer	getPeriodicalUpdate() Does a periodical refresh of the partial page inside the ppr group.
java.lang.String	getReplaceMessages() comma separated List of client Ids that specify the messages components in the page which messages are replaced by this PPRPanelGroup
java.lang.Boolean	getShowDebugMessages() If false, alert messages which can be fired after a ppr response are not displayed in the browser.
java.lang.Boolean	getStateUpdate() If set to false, there will be no stateUpdate on server side due to the partialPage refresh.
java.lang.Integer	getWaitBeforePeriodicalUpdate() This attribute only works in combination with the excludeFromStoppingPeriodicalUpdate attribute.
boolean	isInitializationSent() flag to store the information if the initialization code has been sent to the client already.
void	restoreState(javax.faces.context.FacesContext facesContext, java.lang.Object state)
java.lang.Object	saveState(javax.faces.context.FacesContext facesContext)
void	setAfterUpdateJSHook(java.lang.String afterUpdateJSHook)
void	setAppendMessages(java.lang.String appendMessages)
void	setComponentUpdateFunction(java.lang.String componentUpdateFunction)
void	setExcludeFromStoppingPeriodicalUpdate(java.lang.String excludeFromStoppingPeriodicalUpdate)
void	setInitializationSent(boolean initializationSent)
void	setInlineLoadingMessage(java.lang.String inlineLoadingMessage)
void	setPartialTriggerPattern(java.lang.String partialTriggerPattern)
void	setPartialTriggers(java.lang.String partialTriggers)
void	setPeriodicalTriggers(java.lang.String periodicalTriggers)
void	setPeriodicalUpdate(java.lang.Integer periodicalUpdate)
void	setReplaceMessages(java.lang.String replaceMessages)
void	setShowDebugMessages(java.lang.Boolean showDebugMessages)
void	setStateUpdate(java.lang.Boolean stateUpdate)
void	setWaitBeforePeriodicalUpdate(java.lang.Integer waitBeforePeriodicalUpdate)

Methods inherited from class org.apache.myfaces.custom.ppr.AbstractPPRPanelGroup

getInitializationSent, parsePartialTriggers, parsePeriodicalTriggers

Methods inherited from class org.apache.myfaces.component.html.ext.HtmlPanelGroup

getColspan, getDir, getDisplayValueOnly, getDisplayValueOnlyStyle, getDisplayValueOnlyStyleClass, getEnabledOnUserRole, getLang, getLayout, getOnclick, getOndblclick, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getTitle, getVisibleOnUserRole, isForceId, isForceIdIndex, setColspan, setDir, setDisplayValueOnly, setDisplayValueOnlyStyle, setDisplayValueOnlyStyleClass, setEnabledOnUserRole, setForceId, setForceIdIndex, setLang, setLayout, setOnclick, setOndblclick, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setTitle, setVisibleOnUserRole

Methods inherited from class org.apache.myfaces.component.html.ext.AbstractHtmlPanelGroup

getClientId, isDisplayValueOnly, isRendered, isSetDisplayValueOnly, setDisplayValueOnly

Methods inherited from class javax.faces.component.html.HtmlPanelGroup

getStyle, getStyleClass, setStyle, setStyleClass

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

DEFAULT_RENDERER_TYPE

public static final java.lang.String DEFAULT_RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

PPRPanelGroup

public PPRPanelGroup()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class org.apache.myfaces.component.html.ext.HtmlPanelGroup

getPartialTriggers

public java.lang.String getPartialTriggers()

Description copied from class: AbstractPPRPanelGroup

Comma or Space seperated List of ids from ui_command-items which trigger a partial update of this PanelGroup

Specified by:

getPartialTriggers in class AbstractPPRPanelGroup

setPartialTriggers

public void setPartialTriggers(java.lang.String partialTriggers)

getPeriodicalUpdate

public java.lang.Integer getPeriodicalUpdate()

Description copied from class: AbstractPPRPanelGroup

Does a periodical refresh of the partial page inside the ppr group. In milliseconds. No partialTriggers are needed.

Specified by:

getPeriodicalUpdate in class AbstractPPRPanelGroup

setPeriodicalUpdate

public void setPeriodicalUpdate(java.lang.Integer periodicalUpdate)

getComponentUpdateFunction

public java.lang.String getComponentUpdateFunction()

Description copied from class: AbstractPPRPanelGroup

client javascript function which will do the actual dom update. function signature: function(formNodeElement, updateTargetElement, pprResponseElement)

Specified by:

getComponentUpdateFunction in class AbstractPPRPanelGroup

setComponentUpdateFunction

public void setComponentUpdateFunction(java.lang.String componentUpdateFunction)

getPeriodicalTriggers

public java.lang.String getPeriodicalTriggers()

Description copied from class: AbstractPPRPanelGroup

If a periodicalUpdate is set this trigger starts the periodical requests. No partialTriggers are needed.

Specified by:

getPeriodicalTriggers in class AbstractPPRPanelGroup

setPeriodicalTriggers

public void setPeriodicalTriggers(java.lang.String periodicalTriggers)

getPartialTriggerPattern

public java.lang.String getPartialTriggerPattern()

Description copied from class: AbstractPPRPanelGroup

Regular Expression If the client Id of a submitting Component matches this Pattern the corresponding pprPanelGroup is updated via AJAX

Specified by:

getPartialTriggerPattern in class AbstractPPRPanelGroup

setPartialTriggerPattern

public void setPartialTriggerPattern(java.lang.String partialTriggerPattern)

getExcludeFromStoppingPeriodicalUpdate

public java.lang.String getExcludeFromStoppingPeriodicalUpdate()

Description copied from class: AbstractPPRPanelGroup

Normally when a link is clicked during periodical update, the update is stopped in order to prevent the server from getting unexpected requests. For any POST-request this is the wanted behaviour because the screen is completely refreshed and periodical updating starts again after the response. However, this behaviour may be unwanted e.g. in case of opening a new window with a link where the main screen should stay refreshed. This attribute takes a regular expression of link-client-ids for which the periodical update should not be stopped. If this value is given, there will be a default timeout of 2000 milliseconds before any periodical update will start again. This is done as mentioned before in order to prevent the server from getting unexpected requests. This timeout can be influenced via the waitBeforePeriodicalUpdate attribute.

Specified by:

getExcludeFromStoppingPeriodicalUpdate in class AbstractPPRPanelGroup

setExcludeFromStoppingPeriodicalUpdate

public void setExcludeFromStoppingPeriodicalUpdate(java.lang.String excludeFromStoppingPeriodicalUpdate)

getWaitBeforePeriodicalUpdate

public java.lang.Integer getWaitBeforePeriodicalUpdate()

Description copied from class: AbstractPPRPanelGroup

This attribute only works in combination with the excludeFromStoppingPeriodicalUpdate attribute. The value in milliseconds tells the periodical update mechanism to stop for the given amount of time after clicking a link, specified by the excludeFromStoppingPeriodicalUpdate attribute. The default value is 2000 milliseconds.

Specified by:

getWaitBeforePeriodicalUpdate in class AbstractPPRPanelGroup

setWaitBeforePeriodicalUpdate

public void setWaitBeforePeriodicalUpdate(java.lang.Integer waitBeforePeriodicalUpdate)

getInlineLoadingMessage

public java.lang.String getInlineLoadingMessage()

Description copied from class: AbstractPPRPanelGroup

If this attribute is set the content of the PPRPanelGroup will be replaced by the provided Loading-Message during partial update

Specified by:

getInlineLoadingMessage in class AbstractPPRPanelGroup

setInlineLoadingMessage

public void setInlineLoadingMessage(java.lang.String inlineLoadingMessage)

getShowDebugMessages

public java.lang.Boolean getShowDebugMessages()

Description copied from class: AbstractPPRPanelGroup

If false, alert messages which can be fired after a ppr response are not displayed in the browser. May switched to true in test environments. Default: false

Specified by:

getShowDebugMessages in class AbstractPPRPanelGroup

setShowDebugMessages

public void setShowDebugMessages(java.lang.Boolean showDebugMessages)

getStateUpdate

public java.lang.Boolean getStateUpdate()

Description copied from class: AbstractPPRPanelGroup

If set to false, there will be no stateUpdate on server side due to the partialPage refresh. Default: true

Specified by:

getStateUpdate in class AbstractPPRPanelGroup

setStateUpdate

public void setStateUpdate(java.lang.Boolean stateUpdate)

getAppendMessages

public java.lang.String getAppendMessages()

Description copied from class: AbstractPPRPanelGroup

comma separated List of client Ids that specify the messages components in the page to which messages are appended by this PPRPanelGroup

Specified by:

getAppendMessages in class AbstractPPRPanelGroup

setAppendMessages

public void setAppendMessages(java.lang.String appendMessages)

getReplaceMessages

public java.lang.String getReplaceMessages()

Description copied from class: AbstractPPRPanelGroup

comma separated List of client Ids that specify the messages components in the page which messages are replaced by this PPRPanelGroup

Specified by:

getReplaceMessages in class AbstractPPRPanelGroup

setReplaceMessages

public void setReplaceMessages(java.lang.String replaceMessages)

getAfterUpdateJSHook

public java.lang.String getAfterUpdateJSHook()

Description copied from class: AbstractPPRPanelGroup

Javascript code executed after a ppr update has been completed

Specified by:

getAfterUpdateJSHook in class AbstractPPRPanelGroup

setAfterUpdateJSHook

public void setAfterUpdateJSHook(java.lang.String afterUpdateJSHook)

isInitializationSent

public boolean isInitializationSent()

Description copied from class: AbstractPPRPanelGroup

flag to store the information if the initialization code has been sent to the client already. This gets state-saved to have it available between requests, e.g. to make it work within ppr responses too.

Specified by:

isInitializationSent in class AbstractPPRPanelGroup

setInitializationSent

public void setInitializationSent(boolean initializationSent)

Specified by:

setInitializationSent in class AbstractPPRPanelGroup

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext facesContext)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class org.apache.myfaces.component.html.ext.HtmlPanelGroup

restoreState

public void restoreState(javax.faces.context.FacesContext facesContext,
                         java.lang.Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class org.apache.myfaces.component.html.ext.HtmlPanelGroup