org.apache.myfaces.custom.ppr
Class AbstractPPRPanelGroup

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

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

Direct Known Subclasses:

PPRPanelGroup

public abstract class AbstractPPRPanelGroup
extends org.apache.myfaces.component.html.ext.HtmlPanelGroup

AJAX component which supports updating its children via AJAX calls. These updates can occur regularly or based on triggering input components.

Author:

Ernst Fastl

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

AbstractPPRPanelGroup()

Method Summary

abstract java.lang.String	getAfterUpdateJSHook() Javascript code executed after a ppr update has been completed
abstract 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
abstract java.lang.String	getComponentUpdateFunction() client javascript function which will do the actual dom update.
abstract 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.
boolean	getInitializationSent()
abstract 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
abstract java.lang.String	getPartialTriggerPattern() Regular Expression If the client Id of a submitting Component matches this Pattern the corresponding pprPanelGroup is updated via AJAX
abstract java.lang.String	getPartialTriggers() Comma or Space seperated List of ids from ui_command-items which trigger a partial update of this PanelGroup
abstract java.lang.String	getPeriodicalTriggers() If a periodicalUpdate is set this trigger starts the periodical requests.
abstract java.lang.Integer	getPeriodicalUpdate() Does a periodical refresh of the partial page inside the ppr group.
abstract 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
abstract java.lang.Boolean	getShowDebugMessages() If false, alert messages which can be fired after a ppr response are not displayed in the browser.
abstract java.lang.Boolean	getStateUpdate() If set to false, there will be no stateUpdate on server side due to the partialPage refresh.
abstract java.lang.Integer	getWaitBeforePeriodicalUpdate() This attribute only works in combination with the excludeFromStoppingPeriodicalUpdate attribute.
abstract boolean	isInitializationSent() flag to store the information if the initialization code has been sent to the client already.
java.util.List	parsePartialTriggers()
java.util.List	parsePeriodicalTriggers()
abstract void	setInitializationSent(boolean initializationSent)

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

getColspan, getDir, getDisplayValueOnly, getDisplayValueOnlyStyle, getDisplayValueOnlyStyleClass, getEnabledOnUserRole, getFamily, getLang, getLayout, getOnclick, getOndblclick, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getTitle, getVisibleOnUserRole, isForceId, isForceIdIndex, restoreState, saveState, 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_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

DEFAULT_RENDERER_TYPE

public static final java.lang.String DEFAULT_RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

AbstractPPRPanelGroup

public AbstractPPRPanelGroup()

Method Detail

getPartialTriggers

public abstract java.lang.String getPartialTriggers()

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

getPeriodicalUpdate

public abstract java.lang.Integer getPeriodicalUpdate()

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

getComponentUpdateFunction

public abstract java.lang.String getComponentUpdateFunction()

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

getPeriodicalTriggers

public abstract java.lang.String getPeriodicalTriggers()

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

getPartialTriggerPattern

public abstract java.lang.String getPartialTriggerPattern()

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

getExcludeFromStoppingPeriodicalUpdate

public abstract 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. 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.

getWaitBeforePeriodicalUpdate

public abstract java.lang.Integer getWaitBeforePeriodicalUpdate()

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.

getInlineLoadingMessage

public abstract 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

getShowDebugMessages

public abstract java.lang.Boolean getShowDebugMessages()

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

getStateUpdate

public abstract java.lang.Boolean getStateUpdate()

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

getAppendMessages

public abstract 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

getReplaceMessages

public abstract 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

getAfterUpdateJSHook

public abstract java.lang.String getAfterUpdateJSHook()

Javascript code executed after a ppr update has been completed

getInitializationSent

public boolean getInitializationSent()

isInitializationSent

public abstract boolean isInitializationSent()

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.

setInitializationSent

public abstract void setInitializationSent(boolean initializationSent)

parsePartialTriggers

public java.util.List parsePartialTriggers()

Returns:

PartialTriggerParser.PartialTrigger

parsePeriodicalTriggers

public java.util.List parsePeriodicalTriggers()

Returns:

PartialTriggerParser.PartialTrigger