Project Documentation
Foundation

Summary

Tag name: <s:pprPanelGroup>
UIComponent class: org.apache.myfaces.custom.ppr.PPRPanelGroup
Tag class: org.apache.myfaces.custom.ppr.PPRPanelGroupTag
Component type: org.apache.myfaces.PPRPanelGroup
Component family: org.apache.myfaces.PPRPanelGroup
Renderer type: org.apache.myfaces.PPRPanelGroup
Renderer class: org.apache.myfaces.custom.ppr.PPRPanelGroupRenderer

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

Attributes

Name Type Supports EL? Description
afterUpdateJSHook String Yes Javascript code executed after a ppr update has been completed
appendMessages String Yes comma separated List of client Ids that specify the messages components in the page to which messages are appended by this PPRPanelGroup
binding org.apache.myfaces.custom.ppr.PPRPanelGroup Only EL Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.
colspan int Yes standard html colspan attribute for table cell
componentUpdateFunction String Yes client javascript function which will do the actual dom update. function signature: function(formNodeElement, updateTargetElement, pprResponseElement)
dir String Yes HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
displayValueOnly Boolean Yes If true, renders only the value of the component, but no input widget. Default is false.
displayValueOnlyStyle String Yes Style used when displayValueOnly is true.
displayValueOnlyStyleClass String Yes Style class used when displayValueOnly is true.
enabledOnUserRole String Yes If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.
excludeFromStoppingPeriodicalUpdate String Yes 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.
forceId boolean No If true, this component will force the use of the specified id when rendering.
forceIdIndex boolean No If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.)
id String Yes Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view.
inlineLoadingMessage String Yes If this attribute is set the content of the PPRPanelGroup will be replaced by the provided Loading-Message during partial update
lang String Yes HTML: The base language of this document.
layout String Yes Determines the type of layout that is used when rendering a panelGroup: when 'block' is specified, an HTML div is rendered instead of the default HTML span.
onclick String Yes HTML: Script to be invoked when the element is clicked.
ondblclick String Yes HTML: Script to be invoked when the element is double-clicked.
onkeydown String Yes HTML: Script to be invoked when a key is pressed down over this element.
onkeypress String Yes HTML: Script to be invoked when a key is pressed over this element.
onkeyup String Yes HTML: Script to be invoked when a key is released over this element.
onmousedown String Yes HTML: Script to be invoked when the pointing device is pressed over this element.
onmousemove String Yes HTML: Script to be invoked when the pointing device is moved while it is in this element.
onmouseout String Yes HTML: Script to be invoked when the pointing device is moves out of this element.
onmouseover String Yes HTML: Script to be invoked when the pointing device is moved into this element.
onmouseup String Yes HTML: Script to be invoked when the pointing device is released over this element.
partialTriggerPattern String Yes Regular Expression If the client Id of a submitting Component matches this Pattern the corresponding pprPanelGroup is updated via AJAX
partialTriggers String Yes Comma or Space seperated List of ids from ui_command-items which trigger a partial update of this PanelGroup
periodicalTriggers String Yes If a periodicalUpdate is set this trigger starts the periodical requests. No partialTriggers are needed.
periodicalUpdate Integer Yes Does a periodical refresh of the partial page inside the ppr group. In milliseconds. No partialTriggers are needed.
rendered boolean Yes A boolean value that indicates whether this component should be rendered. Default value: true.
replaceMessages String Yes comma separated List of client Ids that specify the messages components in the page which messages are replaced by this PPRPanelGroup
showDebugMessages Boolean Yes 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
stateUpdate Boolean Yes If set to false, there will be no stateUpdate on server side due to the partialPage refresh. Default: true
style String Yes HTML: CSS styling instructions.
styleClass String Yes The CSS class for this element. Corresponds to the HTML 'class' attribute.
title String Yes HTML: An advisory title for this element. Often used by the user agent as a tooltip.
visibleOnUserRole String Yes If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.
waitBeforePeriodicalUpdate Integer Yes 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.