pe

Tag Library Information 
InfoValue
ID (tag prefix)pe
URIhttp://primefaces.org/ui/extensions
Tag Summary 
TagDescription
assignableParam AssignableParam can be used the apply a parameter of the RemoteCommand to a backing bean.
blockUI BlockUI blocks any piece of page during various Ajax calls.
calculator Calculator adds a popup calculator to a given input field. Client behavior events: open - fires when the calculator is opened (org.primefaces.extensions.event.OpenEvent), close - fires when the calculator is closed (org.primefaces.extensions.event.CloseEvent), button - fires when each calculator button is pressed (org.primefaces.extensions.event.ButtonEvent).
case Tag which defines a case for the switch component.
clipboard Clipboard allows copy/cut functions without the need for Flash. Client behavior events: success - fires when the clipboard sucessfully copies/cuts (org.primefaces.extensions.event.ClipboardSuccessEvent), error - fires when the clipboard fails to copy/cut (org.primefaces.extensions.event.ClipboardErrorEvent).
clockpickerClockPicker based on https://weareoutman.github.io/clockpicker/
codeMirror NOTICE: You must also include the org.primefaces.extensions.resources-codemirror:*.jar artifact. Client behavior events: change - fired every time the content of the editor is changed (javax.faces.event.AjaxBehaviorEvent), highlightComplete - fired whenever the editor's content has been fully highlighted (javax.faces.event.AjaxBehaviorEvent), focus - fired when the editor gets focus (javax.faces.event.AjaxBehaviorEvent), blur - fired when the editor loses focus (javax.faces.event.AjaxBehaviorEvent).
codeScanner CodeScanner allows you to scan bar and QR codes using a device camera. Client behavior events: codeScanned - fires when a code is scanned (org.primefaces.event.SelectEvent).
convertJson Converter to convert JSON.
convertLocale Converter to convert an ISO Locale.
cookiePolicy Cookie Policy component.
counter Counter component animates a numerical value by counting to it. Client behavior events: start - fires when the counter is started (org.primefaces.event.SelectEvent), end - fires when the counter is stopped (org.primefaces.event.SelectEvent).
creditCard CreditCard will take any card form and make it the best part of the checkout process.
defaultCase Tag which defines the default case for the switch component.
documentViewer PDF Viewer based on Mozilla PDF.js to display PDF documents in browser.
dynaForm DynaForm allows to show a dynamic form described by model.
dynaFormControl Specifies a control for a certain typed element within DynaForm.
echart Apache ECharts component using raw JSON model.
fluidGrid FluidGrid is a grid layout library. Client behavior events: layoutComplete - fired after a layout and all positioning transitions have been completed. (org.primefaces.extensions.event.LayoutCompleteEvent).
fluidGridItem Specifies an item for a certain typed element within FluidGrid.
fuzzySearchFast SublimeText-like fuzzy search for JavaScript.
gChart GChart is a JSF wrapper of Google Charts API. Client behavior events: select - fired when a "row" is selected (org.primefaces.event.SelectEvent)
head Custom HTML head renderer.
imageAreaSelect Widget for selecting a rectangular area of an image. Client behavior events: selectEnd - fired after the selection finished (org.primefaces.extensions.event.ImageAreaSelectEvent), selectStart - fired after the selection started (org.primefaces.extensions.event.ImageAreaSelectEvent), selectChange - fired after the selection changed (org.primefaces.extensions.event.ImageAreaSelectEvent).
imageRotateAndResize Widget for rotating or resizing an image. Client behavior events: rotate - fired after image rotation (org.primefaces.extensions.event.RotateEvent), resize - fired after image resizing (org.primefaces.extensions.event.ResizeEvent).
imageZoom Widget for zooming an image.
inputOtp InputOtp is an input component suitable for inserting fixed-size PINs or OTPs.
inputPhone InputPhone is an extension to the inputText with optimized handling for phone numbers. Client behavior events: countrySelect - fires when a country is selected (org.primefaces.event.SelectEvent).
inputPlace InputPlace is a component to wrap Google Places AutoComplete functionality. Client behavior events: placeChanged - fires when a place is selected (org.primefaces.event.SelectEvent)
javascript Behavior to intercept a Javascript event to prevent the AJAX from firing.
keynote Keynote is an HTML presentation component that enables to create fully-featured and beautiful presentations. Client behavior events: slideChanged - fires each time the slide changes (org.primefaces.event.KeynoteEvent), slideTransitionEnd - fires instantly as soon as the slide changes (org.primefaces.event.KeynoteEvent).
keynoteItem Specifies an item for a certain typed element within Keynote.
layout Page Layout component. Client behavior events: open - fires after a layout pane gets opened (org.primefaces.extensions.event.OpenEvent), close - fires after a layout pane gets closed (org.primefaces.extensions.event.CloseEvent), resize - fires after a layout pane gets resized (org.primefaces.extensions.event.ResizeEvent).
layoutPane Layout pane within Layout component. 5 regions are supported: 'north', 'south', 'center', 'west' und 'east'.
legend Legend is a key value based legend.
lightSwitch LightSwitch automatically switched to light or dark theme depending on the OS settings. Client behavior events: switch - fires on switch (org.primefaces.event.SelectEvent).
localized Localized component reads file contents from the /WEB-INF/pfe-localized/ folder, or uses inline content, in the appropriate language (and country), with opional EL and Markdown support.
markdownEditor MarkdownEditor is an extension text area replacement for writing beautiful and understandable Markdown.
masterDetail MasterDetail component allows to group contents into levels (sections) and saves page space. Smart and flexible navigation between levels via breadcrumbs or command components gives a neat and stylish interface for users.
masterDetailLevel A single level for the Master Detail component.
methodParam Method can be used to receive a parameter of the RemoteCommand in the actionListener or action method.
methodSignatureNo Description
monacoDiffEditor A JSF component that wraps the JavaScript libary Monaco Editor. This component renders the diff editor directly into the host page without an iframe. Available client behavior events:
  • initialized - fired when the editor has become ready (javax.faces.event.AjaxBehaviorEvent). That is, after required resources have been downloaded and the editor was fully created and can now be interacted with by the user.
  • originalBlur - fired when the original editor loses focus (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onDidBlurEditorWidget.
  • originalChange - fired if the content of the original editor has been changed (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onDidChangeModelContent.
  • originalFocus - fired when the original editor gets focus (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onDidFocusEditorWidget.
  • ,
  • originalKeydown - fired when a key was pressed down on the original editor (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onKeyDown.
  • ,
  • originalKeyup - fired when a key was released on the original editor (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onKeyUp.
  • ,
  • originalMousedown - fired when a mouse button was pressed down on the original editor (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onMouseDown.
  • ,
  • originalMousemove - fired when the mouse was moved over the original editor (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onMouseMove.
  • ,
  • originalMouseup - fired when a mouse button was released down on the original editor (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onMouseUp.
  • ,
  • originalPaste - fired when the text was pasted into the original editor (javax.faces.event.AjaxBehaviorEvent),
  • ,
  • blur - fired when the modified editor loses focus (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onDidBlurEditorWidget.
  • change - fired if the content of the modified editor has been changed (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onDidChangeModelContent.
  • focus - fired when the modified editor gets focus (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onDidFocusEditorWidget.
  • ,
  • keydown - fired when a key was pressed down on the modified editor (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onKeyDown.
  • ,
  • keyup - fired when a key was released on the modified editor (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onKeyUp.
  • ,
  • mousedown - fired when a mouse button was pressed down on the modified editor (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onMouseDown.
  • ,
  • mousemove - fired when the mouse was moved over the modified editor (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onMouseMove.
  • ,
  • mouseup - fired when a mouse button was released down on the modified editor (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onMouseUp.
  • ,
  • paste - fired when the text was pasted into the modified editor (javax.faces.event.AjaxBehaviorEvent),
  • ,
monacoDiffEditorFramed A JSF component that wraps the JavaScript libary Monaco Editor. This component renders the diff editor inside an iframe for improved encapsulation, as the Monaco editor library and its settings are window global. This also mean that you cannot get access to the monaco editor instance from the PrimeFaces widget. However, the widget offers a method invokeMonaco(methodName, ...params) that lets you call a method on the monaco editor instance in the iframe -- the method parameters are sent via postMessage. Note, however, that this does not work for methods that takes a non-data object as a parameter or return such an object (i.e. an object that cannot be structurally cloned). Available client behavior events:
  • initialized - fired when the editor has become ready (javax.faces.event.AjaxBehaviorEvent). That is, after required resources have been downloaded and the editor was fully created and can now be interacted with by the user.
  • originalBlur - fired when the original editor loses focus (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onDidBlurEditorWidget.
  • originalChange - fired if the content of the original editor has been changed (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onDidChangeModelContent.
  • originalFocus - fired when the original editor gets focus (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onDidFocusEditorWidget.
  • ,
  • originalKeydown - fired when a key was pressed down on the original editor (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onKeyDown.
  • ,
  • originalKeyup - fired when a key was released on the original editor (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onKeyUp.
  • ,
  • originalMousedown - fired when a mouse button was pressed down on the original editor (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onMouseDown.
  • ,
  • originalMousemove - fired when the mouse was moved over the original editor (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onMouseMove.
  • ,
  • originalMouseup - fired when a mouse button was released down on the original editor (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onMouseUp.
  • ,
  • originalPaste - fired when the text was pasted into the original editor (javax.faces.event.AjaxBehaviorEvent),
  • ,
  • blur - fired when the modified editor loses focus (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onDidBlurEditorWidget.
  • change - fired if the content of the modified editor has been changed (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onDidChangeModelContent.
  • focus - fired when the modified editor gets focus (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onDidFocusEditorWidget.
  • ,
  • keydown - fired when a key was pressed down on the modified editor (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onKeyDown.
  • ,
  • keyup - fired when a key was released on the modified editor (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onKeyUp.
  • ,
  • mousedown - fired when a mouse button was pressed down on the modified editor (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onMouseDown.
  • ,
  • mousemove - fired when the mouse was moved over the modified editor (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onMouseMove.
  • ,
  • mouseup - fired when a mouse button was released down on the modified editor (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onMouseUp.
  • ,
  • paste - fired when the text was pasted into the modified editor (javax.faces.event.AjaxBehaviorEvent),
  • ,
monacoEditor A JSF component that wraps the JavaScript libary Monaco Editor. This component renders the editor directly into the host page without an iframe. Available client behavior events:
  • blur - fired when the editor loses focus (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onDidBlurEditorWidget.
  • change - fired if the content has been changed (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onDidChangeModelContent.
  • focus - fired when the editor gets focus (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onDidFocusEditorWidget.
  • ,
  • initialized - fired when the editor has become ready (javax.faces.event.AjaxBehaviorEvent). That is, after required resources have been downloaded and the editor was fully created and can now be interacted with by the user.
  • keydown - fired when a key was pressed down on the editor (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onKeyDown.
  • ,
  • keyup - fired when a key was released on the editor (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onKeyUp.
  • ,
  • mousedown - fired when a mouse button was pressed down on the editor (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onMouseDown.
  • ,
  • mousemove - fired when the mouse was moved over the editor (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onMouseMove.
  • ,
  • mouseup - fired when a mouse button was released down on the editor (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onMouseUp.
  • ,
  • paste - fired when the text was pasted into the editor (javax.faces.event.AjaxBehaviorEvent),
  • ,
monacoEditorFramed A JSF component that wraps the JavaScript libary Monaco Editor. This component renders the editor inside an iframe for improved encapsulation, as the monaco editor library and its settings are window global. This also mean that you cannot get access to the monaco editor instance from the PrimeFaces widget. However, the widget offers a method invokeMonaco(methodName, ...params) that lets you call a method on the monaco editor instance in the iframe -- the method parameters are sent via postMessage. Note, however, that this does not work for methods that takes a non-data object as a parameter or return such an object (i.e. an object that cannot be structurally cloned). Available client behavior events:
  • blur - fired when the editor loses focus (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onDidBlurEditorWidget.
  • change - fired if the content has been changed (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onDidChangeModelContent.
  • focus - fired when the editor gets focus (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onDidFocusEditorWidget.
  • ,
  • initialized - fired when the editor has become ready (javax.faces.event.AjaxBehaviorEvent). That is, after required resources have been downloaded and the editor was fully created and can now be interacted with by the user.
  • keydown - fired when a key was pressed down on the editor (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onKeyDown.
  • ,
  • keyup - fired when a key was released on the editor (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onKeyUp.
  • ,
  • mousedown - fired when a mouse button was pressed down on the editor (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onMouseDown.
  • ,
  • mousemove - fired when the mouse was moved over the editor (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onMouseMove.
  • ,
  • mouseup - fired when a mouse button was released down on the editor (javax.faces.event.AjaxBehaviorEvent). Corresponds to IStandaloneCodeEditor#onMouseUp.
  • ,
  • paste - fired when the text was pasted into the editor (javax.faces.event.AjaxBehaviorEvent),
  • ,
orgchart OrgChart based on https://github.com/dabeng/OrgChart
osmapOpen Street Map using leaflet https://leafletjs.com/
qrCode Generate QR codes dynamically
remoteCommand RemoteCommand provides a way to execute JSF backing bean methods directly from javascript.
sanitizer Converter to sanitize HTML with an OWASP PolicyFactory.
saveCookiePolicy Tag Handler for saving a cookie policy.
selectDetailLevel Tag handler for selecting a master detail level.
sessionGives client-side Javascript events when session will expire.
sheet Data sheet providing Excel like editing, frozen columns and rows, copy/paste, sorting, etc.
sheetcolumn Data sheet column used to define the available columns in a Sheet component.
slideout SlideOut adds a tab slideout from the screen edge. Client behavior events: open - fires when the slideout is opened (org.primefaces.extensions.event.OpenEvent), close - fires when the slideout is closed (org.primefaces.extensions.event.CloseEvent).
speedtest Speedtest adds a view with Speedtest gauges. Fires an event when the speedtest has been finished.
sunEditor SunEditor component, wysiwyg html editor in js. Client behavior events: change - on change (javax.faces.event.AjaxBehaviorEvent), scroll - on scroll (javax.faces.event.AjaxBehaviorEvent), mousedown - on mouseDown (javax.faces.event.AjaxBehaviorEvent), click - on click (javax.faces.event.AjaxBehaviorEvent), input - on input (javax.faces.event.AjaxBehaviorEvent), keydown - on keyDown (javax.faces.event.AjaxBehaviorEvent), keyup - on keyUp (javax.faces.event.AjaxBehaviorEvent), focus - on focus (javax.faces.event.AjaxBehaviorEvent), blur - on blur (javax.faces.event.AjaxBehaviorEvent), paste - on paste (javax.faces.event.AjaxBehaviorEvent), copy - on copy (javax.faces.event.AjaxBehaviorEvent), cut - on cut (javax.faces.event.AjaxBehaviorEvent), drop - on drop (javax.faces.event.AjaxBehaviorEvent), save - on save (javax.faces.event.AjaxBehaviorEvent). initialize - when editor is initialized (javax.faces.event.AjaxBehaviorEvent).
switch Tag to simulate a java switch.
timeAgo TimeAgo renders automatically updating fuzzy timestamps.
timePicker Time picker component for time (hours / minutes) inputs. Client behavior events: timeSelect - fires when an hour / minutes is selected (org.primefaces.extensions.event.TimeSelectEvent), close - fires when the time picker is closed (org.primefaces.extensions.event.CloseEvent), beforeShow - fires before the time picker is rendered and displayed (org.primefaces.extensions.event.BeforeShowEvent).
timer Timer Component
tooltip Advanced Tooltip component.
triStateManyCheckbox Tri-State multiple checkbox component.
waypoint Waypoint makes it easy to execute a custom logic whenever you scroll to an element. Client behavior events: reached - fired when the user scrolls past the element. (org.primefaces.extensions.event.WaypointEvent)
Function Summary 
TypeFunctionDescription
java.lang.StringencodeURL(java.lang.String)No Description
java.lang.StringescapeSelector(java.lang.String)No Description

Output generated by Vdldoc View Declaration Language Documentation Generator.