Tomahawk sandbox tag library.
Tag pprPanelGroup

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

Tag Information
Tag Classorg.apache.myfaces.custom.ppr.PPRPanelGroupTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

partialTriggersfalsefalsejava.lang.StringComma or Space seperated List of ids from ui_command-items which trigger a partial update of this PanelGroup
periodicalUpdatefalsefalsejava.lang.StringDoes a periodical refresh of the partial page inside the ppr group. In milliseconds. No partialTriggers are needed.
componentUpdateFunctionfalsefalsejava.lang.Stringclient javascript function which will do the actual dom update. function signature: function(formNodeElement, updateTargetElement, pprResponseElement)
periodicalTriggersfalsefalsejava.lang.StringIf a periodicalUpdate is set this trigger starts the periodical requests. No partialTriggers are needed.
partialTriggerPatternfalsefalsejava.lang.StringRegular Expression If the client Id of a submitting Component matches this Pattern the corresponding pprPanelGroup is updated via AJAX
excludeFromStoppingPeriodicalUpdatefalsefalsejava.lang.StringNormally 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.
waitBeforePeriodicalUpdatefalsefalsejava.lang.StringThis 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.
inlineLoadingMessagefalsefalsejava.lang.StringIf this attribute is set the content of the PPRPanelGroup will be replaced by the provided Loading-Message during partial update
showDebugMessagesfalsefalsejava.lang.StringIf 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
stateUpdatefalsefalsejava.lang.StringIf set to false, there will be no stateUpdate on server side due to the partialPage refresh. Default: true
appendMessagesfalsefalsejava.lang.Stringcomma separated List of client Ids that specify the messages components in the page to which messages are appended by this PPRPanelGroup
replaceMessagesfalsefalsejava.lang.Stringcomma separated List of client Ids that specify the messages components in the page which messages are replaced by this PPRPanelGroup
afterUpdateJSHookfalsefalsejava.lang.StringJavascript code executed after a ppr update has been completed
layoutfalsefalsejava.lang.StringDetermines 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.
colspanfalsefalsejava.lang.Stringstandard html colspan attribute for table cell
onclickfalsefalsejava.lang.StringHTML: Script to be invoked when the element is clicked.
ondblclickfalsefalsejava.lang.StringHTML: Script to be invoked when the element is double-clicked.
onkeydownfalsefalsejava.lang.StringHTML: Script to be invoked when a key is pressed down over this element.
onkeypressfalsefalsejava.lang.StringHTML: Script to be invoked when a key is pressed over this element.
onkeyupfalsefalsejava.lang.StringHTML: Script to be invoked when a key is released over this element.
onmousedownfalsefalsejava.lang.StringHTML: Script to be invoked when the pointing device is pressed over this element.
onmousemovefalsefalsejava.lang.StringHTML: Script to be invoked when the pointing device is moved while it is in this element.
onmouseoutfalsefalsejava.lang.StringHTML: Script to be invoked when the pointing device is moves out of this element.
onmouseoverfalsefalsejava.lang.StringHTML: Script to be invoked when the pointing device is moved into this element.
onmouseupfalsefalsejava.lang.StringHTML: Script to be invoked when the pointing device is released over this element.
displayValueOnlyfalsefalsejava.lang.StringIf true, renders only the value of the component, but no input widget. Default is false.
displayValueOnlyStylefalsefalsejava.lang.StringStyle used when displayValueOnly is true.
displayValueOnlyStyleClassfalsefalsejava.lang.StringStyle class used when displayValueOnly is true.
enabledOnUserRolefalsefalsejava.lang.StringIf user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.
visibleOnUserRolefalsefalsejava.lang.StringIf 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.
forceIdfalsefalsejava.lang.StringIf true, this component will force the use of the specified id when rendering.
forceIdIndexfalsefalsejava.lang.StringIf 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.)
dirfalsefalsejava.lang.StringHTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
langfalsefalsejava.lang.StringHTML: The base language of this document.
titlefalsefalsejava.lang.StringHTML: An advisory title for this element. Often used by the user agent as a tooltip.
stylefalsefalsejava.lang.StringHTML: CSS styling instructions.
styleClassfalsefalsejava.lang.StringThe CSS class for this element. Corresponds to the HTML 'class' attribute.
idfalsefalsejava.lang.StringAn identifier for this particular component instance within a component view.

The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view

This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted.

renderedfalsefalsejava.lang.StringA boolean value that indicates whether this component should be rendered. Default value: true.
bindingfalsefalsejava.lang.StringIdentifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.

No Variables Defined.

Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.