API

This page gives an overview of all available tags.

urn:be:e-contract:ejsf JSF tag library

Enterprise JSF tag library.

This JSF tag library defines 110 tags and is JSF version 2.1 compatible.

Namespace: urn:be:e-contract:ejsf

Functions
acceptAnnouncement

Action to accept the announcement.

Namespace: urn:be:e-contract:ejsf
Required Attributes
NameTypeDescription
retention java.lang.Integer The retention period in seconds for the announcement cookie.
addMessage

Action to add a message.

Namespace: urn:be:e-contract:ejsf
Optional Attributes
NameTypeDescription
severity java.lang.String The severity. Defaults to "INFO".
summary java.lang.String The message summary.
detail java.lang.String The message detail.
target java.lang.String The target component.
whenCallbackParam java.lang.String Only add message when a callback parameter has been set.
whenCallbackParamValue java.lang.String Only add message when a callback parameter value has been set.
callbackParamVar java.lang.String Callback parameter value variable that can be used during evaluation of the message summary and detail.
invalidateTarget java.lang.Boolean Set to true to invalidate the target UIInput component when the condition is met.
addMessageParam

Parameter for addMessage summary or detail messages.

Namespace: urn:be:e-contract:ejsf
Required Attributes
NameTypeDescription
value java.lang.String The parameter value.
Optional Attributes
NameTypeDescription
for java.lang.String The target message. summary or detail. Defaults to summary.
ageValidator

Age validator.

Namespace: urn:be:e-contract:ejsf
Required Attributes
NameTypeDescription
minimumAge java.lang.Integer The minimum age required to pass validation.
Optional Attributes
NameTypeDescription
message java.lang.String The optional validation error message.
for java.lang.String
announcement

Announcement component.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.announcementComponent
Component Class: be.e_contract.ejsf.component.announcement.AnnouncementComponent
Optional Attributes
NameTypeDescription
name java.lang.Integer The name of the announcement cookie. Defaults to 'announcement'.
version java.lang.Integer The version of the announcement.
announcementVersions

UIData component for announcement versions to be announced.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.announcementVersionsComponent
Component Class: be.e_contract.ejsf.component.announcement.AnnouncementVersionsComponent
Required Attributes
NameTypeDescription
var java.lang.String The EL variable containing the version.
Optional Attributes
NameTypeDescription
oldestVersion java.lang.Integer The optional oldest version for which there is still an announcement.
order java.lang.String The order in which to iterate the versions. Possible values: 'asc' or 'desc'. Defaults to 'asc'.
async

Component for asynchronous value loading.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.asyncComponent
Component Class: be.e_contract.ejsf.component.async.AsyncComponent
Required Attributes
NameTypeDescription
value java.lang.Object The value to be loading asynchronously.
Optional Attributes
NameTypeDescription
for java.lang.String The optional id of the output component
autoSubmit

Automatically submit upon a condition.

Namespace: urn:be:e-contract:ejsf
Required Attributes
NameTypeDescription
whenLength java.lang.Integer Automatically submit when length of input has been reached.
Optional Attributes
NameTypeDescription
target java.lang.String Identifier of the default command component. If not provided, we submit the form.
battery

Battery output component.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.batteryComponent
Component Class: be.e_contract.ejsf.component.output.battery.BatteryComponent
Required Attributes
NameTypeDescription
value java.lang.Number The battery level value. Value ranges from 0 to 100.
height java.lang.Integer The height of the battery.
width java.lang.Integer The width of the battery.
browser

Only renders on a specified browser.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.browserComponent
Component Class: be.e_contract.ejsf.component.browser.BrowserComponent
Required Attributes
NameTypeDescription
name java.lang.String The name of the browser: chrome, edge, firefox, safari
carousel

Lazy loading image carousel.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.carouselComponent
Component Class: be.e_contract.ejsf.component.output.carousel.CarouselComponent
Required Attributes
NameTypeDescription
value java.util.List The list of CarouselImage.
height java.lang.Integer The height style in pixels.
Optional Attributes
NameTypeDescription
width java.lang.String The width style.
autoPlay java.lang.Integer The auto play delay in ms.
lazyFirst java.lang.Boolean Lazy loads even the first image. Defaults to false.
clientBehaviorLogger

Logs all client behavior events on a component via console.log.

Namespace: urn:be:e-contract:ejsf
Optional Attributes
NameTypeDescription
onevent java.lang.String Client side callback to execute in case an event is fired.
clockSync

Clock synchronization component. Requires proper configuration of the ClockSyncServlet within web.xml.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.clockSync
Component Class: be.e_contract.ejsf.component.clocksync.ClockSyncComponent
Required Attributes
NameTypeDescription
clockLocation java.lang.String The location of the ClockSyncServlet.
Optional Attributes
NameTypeDescription
widgetVar java.lang.String The PrimeFaces widget client-side variable.
syncCount java.lang.Integer Number of attempts to synchronize the clock.
acceptedRoundTripDelay java.lang.Integer The accepted round trip delay in milliseconds for synchronization. Defaults to 1000.
maximumClockDrift java.lang.Integer The maximum clock drift in milliseconds to consider us out-of-sync. Defaults to 1000.
sessionKeepAlivePing java.lang.Boolean Set to true to periodically generate an HTTP session keep alive ping.
sessionKeepAliveBeforeExpiryPeriod java.lang.Integer The number of seconds before session expiry that we should ping the server-side. Defaults to 30.
maxKeepAlivePeriod java.lang.Integer The maximum period to keep the session alive in minutes. Indefinitely if not defined.
Client behavior events
sync
error
closeDialog

Client-side behavior to close PrimeFaces dialogs.

Namespace: urn:be:e-contract:ejsf
Optional Attributes
NameTypeDescription
whenCallbackParam java.lang.String Optional condition where a certain callback parameter has to be present.
whenCallbackParamValue java.lang.String Optional condition where a certain callback parameter has to have a certain value.
whenValid java.lang.Boolean Optional condition on the input validation.
target java.lang.String Comma separated list of the dialog widget identifiers to close.
noAjax java.lang.Boolean Set to true to avoid an ajax call upon closing the dialog.
console

Console component.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.consoleComponent
Component Class: be.e_contract.ejsf.component.console.ConsoleComponent
Optional Attributes
NameTypeDescription
widgetVar java.lang.String The PrimeFaces widget client-side variable.
style java.lang.String The optional inline style.
styleClass java.lang.String The optional style class.
timestamp java.lang.Boolean Indicates whether timestamps should be included. Defaults to false.
copyButton

Copy the value to the clipboard.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.copyButtonComponent
Component Class: be.e_contract.ejsf.component.copybutton.CopyButtonComponent
Required Attributes
NameTypeDescription
value java.lang.String The value to be copied to the clipboard.
Optional Attributes
NameTypeDescription
style java.lang.String The optional style for the icon.
copiedIcon java.lang.String Icon to be used when value has been copied to the clipboard.
copyToClipboard

Client behavior to copy a value to the clipboard.

Namespace: urn:be:e-contract:ejsf
Required Attributes
NameTypeDescription
value java.lang.String The value to be copied to the clipboard.
countdown

Countdown component.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.countdownComponent
Component Class: be.e_contract.ejsf.component.countdown.CountdownComponent
Optional Attributes
NameTypeDescription
widgetVar java.lang.String The PrimeFaces widget client-side variable.
useHeartbeatTimer java.lang.Boolean Set to true to use a global heartbeat timer. Defaults to false.
clockSyncWidgetVar java.lang.String The clockSync widget variable used to recalibrate after synchronization.
cronValidator

Cron validator.

Namespace: urn:be:e-contract:ejsf
Required Attributes
NameTypeDescription
cronType java.lang.String The type of cron expression. Accepted values: CRON4J, QUARTZ, UNIX, SPRING, SPRING53
Optional Attributes
NameTypeDescription
message java.lang.String The optional validation error message.
for java.lang.String
d3

Component for D3.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.d3Component
Component Class: be.e_contract.ejsf.component.output.d3.D3Component
Required Attributes
NameTypeDescription
widgetVar java.lang.String The PrimeFaces widget client-side variable.
Optional Attributes
NameTypeDescription
width java.lang.Integer The optional width of the chart. Defaults to 600.
height java.lang.Integer The optional height of the chart. Defaults to 400.
dialog

Component for native HTML dialogs.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.dialogComponent
Component Class: be.e_contract.ejsf.component.dialog.DialogComponent
Optional Attributes
NameTypeDescription
widgetVar java.lang.String The PrimeFaces widget client-side variable.
dictionary

Client-side dictionary component. Useful to provide i18n support from within Javascripts.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.dictionaryComponent
Component Class: be.e_contract.ejsf.component.dictionary.DictionaryComponent
Required Attributes
NameTypeDescription
widgetVar java.lang.String The PrimeFaces widget client-side variable.
dictionaryEntry

An entry for the dictionary.

Namespace: urn:be:e-contract:ejsf
Required Attributes
NameTypeDescription
key java.lang.String The key of this dictionary entry.
value java.lang.String The value of this dictionary entry.
echarts

Component for Apache ECharts.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.echartsComponent
Component Class: be.e_contract.ejsf.component.output.echarts.EChartsComponent
Required Attributes
NameTypeDescription
value java.lang.String The ECharts option JSON structure.
Optional Attributes
NameTypeDescription
width java.lang.Integer The optional width of the chart. Defaults to 600.
height java.lang.Integer The optional height of the chart. Defaults to 400.
widgetVar java.lang.String The PrimeFaces widget client-side variable.
style java.lang.String The optional inline style.
styleClass java.lang.String The optional style class.
Client behavior events
click
elValidator

Expression language validator.

Namespace: urn:be:e-contract:ejsf
Required Attributes
NameTypeDescription
valueVar java.lang.String The variable name for the value.
invalidWhen java.lang.String The EL expression to evaluate.
message java.lang.String The invalid value message. Can also be an EL expression.
Optional Attributes
NameTypeDescription
prevRowVar java.lang.String The variable name for the value of the previous row.
for java.lang.String
emailValidator

Validator for email addresses.

Namespace: urn:be:e-contract:ejsf
Optional Attributes
NameTypeDescription
allowMultiple java.lang.Boolean Allows for multiple comma separated email addresses. Defaults to false.
message java.lang.String The optional validation error message.
for java.lang.String
enum

An enum style. Child of outputEnum.

Namespace: urn:be:e-contract:ejsf
Required Attributes
NameTypeDescription
name java.lang.String The name of the enum value.
Optional Attributes
NameTypeDescription
label java.lang.String The optional human readable enum label.
color java.lang.String The optional color for the enum.
background java.lang.String The optional background color for the enum.
icon java.lang.String The optional PrimeFaces icon for the enum.
fullscreen

Makes a component go fullscreen.

Namespace: urn:be:e-contract:ejsf
Required Attributes
NameTypeDescription
component java.lang.String The component id to render fullscreen.
Optional Attributes
NameTypeDescription
onfullscreen java.lang.String Client side callback to execute when fullscreen transition is completed.
geolocation

Component to provide geolocation.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.geolocationComponent
Component Class: be.e_contract.ejsf.component.geolocation.GeolocationComponent
Optional Attributes
NameTypeDescription
widgetVar java.lang.String The PrimeFaces widget client-side variable.
maximumAge java.lang.Long The maximum age in milliseconds of a possible cached position.
timeout java.lang.Long The maximum length of time (in milliseconds) the device is allowed to take in order to return a position.
enableHighAccuracy java.lang.Boolean Set to true to enable high accuracy.
autoStart java.lang.Boolean Automatically start the geolocation.
Client behavior events
geolocation
error
help

Namespace: urn:be:e-contract:ejsf
highlight

Highlights source code.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.highlightComponent
Component Class: be.e_contract.ejsf.component.output.highlight.HighlightComponent
Optional Attributes
NameTypeDescription
value java.lang.String The optional source code as value.
for java.lang.String The optional element identifier within the XHTML file.
resource java.lang.String The optional source code resource.
language java.lang.String The optional source code language.
homeFileValidator

Home File validator.

Namespace: urn:be:e-contract:ejsf
Optional Attributes
NameTypeDescription
directory java.lang.String The optional directory restriction under the home directory.
type java.lang.String The optional file type. Can be FILE or DIRECTORY. Defaults to FILE.
message java.lang.String The optional validation error message.
for java.lang.String
inetAddressValidator

Internet address validator.

Namespace: urn:be:e-contract:ejsf
Optional Attributes
NameTypeDescription
ipv4Only java.lang.Boolean Set to true to only allow IPv4 addresses.
message java.lang.String The optional validation error message.
for java.lang.String
inlineTranslation

Inline translation.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.inlineTranslation
Component Class: be.e_contract.ejsf.component.i18n.InlineTranslationComponent
input

Input component for dynamically typed inputs. Via facets you can define the actual input component for each type.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.inputComponent
Component Class: be.e_contract.ejsf.component.input.InputComponent
Required Attributes
NameTypeDescription
value java.lang.Object The value.
type java.lang.String The type for the input.
Optional Attributes
NameTypeDescription
defaultType java.lang.String The default type.
inputLocalFile

Input a local file from a given directory.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.inputLocalFileComponent
Component Class: be.e_contract.ejsf.component.input.InputLocalFileComponent
Required Attributes
NameTypeDescription
value java.lang.String The absolute path value of the local file.
directory java.lang.String The directory relative to the user home directory.
Optional Attributes
NameTypeDescription
required java.lang.Boolean True if this input is required.
size java.lang.Integer The optional size of the input field.
requiredRole java.lang.String The requred RBAC role to be able to view local files.
fileFilter java.lang.String The optional regexp filename filter.
inputPeriod

Input component for periods.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.inputPeriodComponent
Component Class: be.e_contract.ejsf.component.input.InputPeriodComponent
Optional Attributes
NameTypeDescription
value java.lang.Integer The period in the unit indicated by unit.
unit java.lang.String The period unit: SECONDS, MINUTES, HOURS, DAYS, MONTHS, YEARS. Defaults to SECONDS.
maxUnit java.lang.String The maximum unit to visualize: SECONDS, MINUTES, HOURS, DAYS, MONTHS, YEARS. Defaults to MONTHS.
disabled java.lang.Boolean Disables the input element, default is false.
inputTemplate

Input component to instantiate a template.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.inputTemplateComponent
Component Class: be.e_contract.ejsf.component.input.template.InputTemplateComponent
Required Attributes
NameTypeDescription
value java.lang.String The template value.
result java.lang.String The template instantiation result value.
insertFacet

Insert a facet.

Namespace: urn:be:e-contract:ejsf
Required Attributes
NameTypeDescription
name java.lang.String The name of the facet.
Optional Attributes
NameTypeDescription
targetName java.lang.String The optional name of the target facet.
jmsInfo

Displays information about JMS.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.jmsInfo
Component Class: be.e_contract.ejsf.component.jmsinfo.JmsInfoComponent
Required Attributes
NameTypeDescription
queue java.lang.String The JMS queue.
Optional Attributes
NameTypeDescription
replayQueue java.lang.String The optional JMS queue used to replay JMS messages.
requiredRole java.lang.String The optional required RBAC role.
removeAction java.lang.Boolean Set to true to show the remove message button.
dateTimePattern java.lang.String The pattern used for formatting datetimes.
Client behavior events
replay
remove
katex

Component to add KaTeX support to a page.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.katexComponent
Component Class: be.e_contract.ejsf.component.KatexComponent
keyStorePasswordValidator

KeyStore Password validator.

Namespace: urn:be:e-contract:ejsf
Required Attributes
NameTypeDescription
keyStoreType java.lang.String The type of the key store. JKS or PKCS12.
forKeyStore java.lang.String The id of the UIInput holding the keystore path.
Optional Attributes
NameTypeDescription
message java.lang.String The optional validation error message.
for java.lang.String
lastReviewed

Outputs a LocalDateTime as last reviewed.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.lastReviewed
Component Class: be.e_contract.ejsf.component.output.LastReviewedComponent
Required Attributes
NameTypeDescription
value java.time.LocalDateTime The last review LocalDateTime value.
Optional Attributes
NameTypeDescription
unknownMessage java.lang.String The message to display in case of a missing last reviewed value. Defaults to "Unknown".
pattern java.lang.String The DateTimeFormatter pattern to use for formatting the value. Defaults to "dd/MM/yyyy HH:mm".
maxAgeWarning java.lang.String The maximum age period after which to mark the last review LocalDateTime value as warning. Defaults to "P3M".
maxAgeError java.lang.String The maximum age period after which to mark the last review LocalDateTime value as error. Defaults to "P6M".
okIcon java.lang.String The optional OK icon to show.
warningIcon java.lang.String The optional warning icon to show.
errorIcon java.lang.String The optional error icon to show.
leaflet

Leaflet component.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.leafletComponent
Component Class: be.e_contract.ejsf.component.leaflet.LeafletComponent
Required Attributes
NameTypeDescription
value be.e_contract.ejsf.component.leaflet.LatLng The initial latitude and longitude for the map.
Optional Attributes
NameTypeDescription
height java.lang.String The optional height of the map. Defaults to "200px".
width java.lang.String The optional width of the map.
widgetVar java.lang.String The PrimeFaces widget client-side variable.
zoomControl java.lang.Boolean Makes the zoom control present or not. Defaults to "true".
zoom java.lang.Integer Initial zoom level. Defaults to 13.
minZoom java.lang.Integer Minimum zoom level. Defaults to 1.
maxZoom java.lang.Integer Maximum zoom level. Defaults to 19.
urlTemplate java.lang.String The URL template. Defaults to https://tile.openstreetmap.org/{z}/{x}/{y}.png
link

Adds a link element to the head.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.linkComponent
Component Class: be.e_contract.ejsf.component.link.LinkComponent
Required Attributes
NameTypeDescription
href java.lang.String The link href attribute.
Optional Attributes
NameTypeDescription
rel java.lang.String The link rel attribute.
linkedData

Component to add JSON-LD to the head.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.linkedDataComponent
Component Class: be.e_contract.ejsf.component.linkeddata.LinkedDataComponent
Optional Attributes
NameTypeDescription
value java.lang.String The JSON-LD value. If not provided, we use the children as value.
marked

Output value as markdown.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.markedComponent
Component Class: be.e_contract.ejsf.component.output.marked.MarkedComponent
Required Attributes
NameTypeDescription
value java.lang.String The markdown to display.
Optional Attributes
NameTypeDescription
widgetVar java.lang.String The PrimeFaces widget client-side variable.
matomoCustomDimension

Adds a Matomo custom dimension to the Matomo tracking.

Namespace: urn:be:e-contract:ejsf
Required Attributes
NameTypeDescription
dimension java.lang.Integer The dimension.
value java.lang.String The value of this dimension.
Optional Attributes
NameTypeDescription
enabled java.lang.Boolean Indicates whether this custom dimension is enabled or not.
matomoTracking

Tracking component using Matomo.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.matomoTrackingComponent
Component Class: be.e_contract.ejsf.component.matomo.TrackingComponent
Required Attributes
NameTypeDescription
enableTracking java.lang.Boolean Set to true to enable page visits tracking.
matomoUrl java.lang.String The URL of the used Matomo instance.
siteId java.lang.String The Matomo site identifier.
Optional Attributes
NameTypeDescription
userId java.lang.String The optional user identifier.
documentTitle java.lang.String The optional document title.
maxViewportHeight

Maximizes the height of the embedding component within the viewport.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.maxViewportHeight
Component Class: be.e_contract.ejsf.component.MaxViewportHeightComponent
Optional Attributes
NameTypeDescription
footer java.lang.String The id of the footer component or element that should also remain visible.
for java.lang.String The optional id of the component or element on which this should apply. If not provided we use the parent component.
minHeight java.lang.Integer The optional minimum height of the component.
memoryInfo

Displays information about the JVM memory.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.memoryInfo
Component Class: be.e_contract.ejsf.component.MemoryInfoComponent
mermaid

Mermaid component.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.mermaidComponent
Component Class: be.e_contract.ejsf.component.mermaid.MermaidComponent
Optional Attributes
NameTypeDescription
value java.lang.String The Mermaid diagram. If not provided, we use the child content as value.
widgetVar java.lang.String The PrimeFaces widget client-side variable.
style java.lang.String The optional inline style.
styleClass java.lang.String The optional style class.
metrics

Displays metrics. Metrics are provided by @Observe-ing be.e_contract.ejsf.api.metrics.MetricsEvent.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.metrics
Component Class: be.e_contract.ejsf.component.MetricsComponent
monkeyPatch

Provides some useful monkey patches for PrimeFaces.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.monkeyPatchComponent
Component Class: be.e_contract.ejsf.component.MonkeyPatchComponent
oidValidator

OID validator.

Namespace: urn:be:e-contract:ejsf
Optional Attributes
NameTypeDescription
message java.lang.String The optional validation error message.
for java.lang.String
openDialog

Client-side behavior to open PrimeFaces dialogs.

Namespace: urn:be:e-contract:ejsf
Optional Attributes
NameTypeDescription
dialog java.lang.String The dialog widget var.
dialogId java.lang.String The dialog id.
whenCallbackParam java.lang.String Optional condition where a certain callback parameter has to be present.
whenCallbackParamValue java.lang.String Optional condition where a certain callback parameter has to have a certain value.
oncomplete java.lang.String Client side callback to execute when ajax request is completed.
openLayersMap

Displays a map using OpenLayers.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.openLayersComponent
Component Class: be.e_contract.ejsf.component.output.ol.OpenLayersComponent
Required Attributes
NameTypeDescription
value be.e_contract.ejsf.component.output.ol.LatLng The initial latitude and longitude for the map.
Optional Attributes
NameTypeDescription
height java.lang.String The optional height of the map. Defaults to "200px".
width java.lang.String The optional width of the map.
zoom java.lang.Integer Initial zoom level. Defaults to 15.
otpValidator

Validator for OTP input.

Namespace: urn:be:e-contract:ejsf
Optional Attributes
NameTypeDescription
message java.lang.String The optional validation error message.
for java.lang.String
outputBoolean

Outputs a styled i18n boolean value.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.outputBoolean
Component Class: be.e_contract.ejsf.component.output.OutputBooleanComponent
Required Attributes
NameTypeDescription
value java.lang.Boolean The boolean value to output.
Optional Attributes
NameTypeDescription
reverse java.lang.Boolean Reverses the color indication when set to true.
colors java.lang.Boolean Set to false to disable red/green coloring.
outputBytes

Output formatted bytes (KB, MB, GB).

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.outputBytes
Component Class: be.e_contract.ejsf.component.output.OutputBytesComponent
Required Attributes
NameTypeDescription
value java.lang.Long The bytes number to output.
Optional Attributes
NameTypeDescription
style java.lang.String The optional inline style.
styleClass java.lang.String The optional style class.
outputCertificate

Outputs an X509 certificate. Child elements get rendered within the table structure per pair.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.outputCertificate
Component Class: be.e_contract.ejsf.component.output.OutputCertificateComponent
Required Attributes
NameTypeDescription
value java.security.cert.X509Certificate The X509 certificate.
Optional Attributes
NameTypeDescription
download java.lang.Boolean Set to true to show a download button.
dateTimePattern java.lang.String The pattern used for formatting datetimes.
outputCurrency

Outputs a value as currency.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.outputCurrency
Component Class: be.e_contract.ejsf.component.output.currency.OutputCurrencyComponent
Required Attributes
NameTypeDescription
value java.lang.Object The currency value. We support Integer, Long, Float, and Double.
Optional Attributes
NameTypeDescription
widgetVar java.lang.String The PrimeFaces widget client-side variable.
currency java.lang.String Optional currency. Defaults to "EUR".
locale java.lang.Object Optional locale as String or Locale.
style java.lang.String The optional inline style.
styleClass java.lang.String The optional style class.
outputDayOfWeek

Outputs the localized version of the day of week (full stand-alone text)

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.outputDayOfWeek
Component Class: be.e_contract.ejsf.component.output.OutputDayOfWeekComponent
Required Attributes
NameTypeDescription
value java.time.DayOfWeek The day of the week to output.
Optional Attributes
NameTypeDescription
styleClass java.lang.String Style class of the main container element.
style java.lang.String The optional inline style.
emptyMessage java.lang.String The optional message to output in case of null value.
outputEmail

Output clickable email.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.outputEmail
Component Class: be.e_contract.ejsf.component.output.OutputEmailComponent
Required Attributes
NameTypeDescription
value java.lang.String The email address.
Optional Attributes
NameTypeDescription
subject java.lang.String The optional email subject.
cc java.lang.String The optional email cc
bcc java.lang.String The optional email bcc
body java.lang.String The optional email body
style java.lang.String The optional inline style.
styleClass java.lang.String The optional style class.
label java.lang.String The optional label.
Client behavior events
click
outputEnum

Outputs a styled enum via embedded enum tags.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.outputEnum
Component Class: be.e_contract.ejsf.component.output.enums.OutputEnumComponent
Required Attributes
NameTypeDescription
value java.lang.Enum The enumeration value to output.
Optional Attributes
NameTypeDescription
handleNullAs java.lang.String Optional enum name in case of null value.
outputFingerprint

Outputs the fingerprint of binary data.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.outputFingerprint
Component Class: be.e_contract.ejsf.component.output.OutputFingerprintComponent
Required Attributes
NameTypeDescription
value java.lang.Object The data as byte array.
Optional Attributes
NameTypeDescription
algo java.lang.String The optional digest algorithm. Defaults to SHA-1.
spacing java.lang.Boolean The optional spacing between each byte hex value.
separator java.lang.String The optional separator. Defaults to a white space.
lowercase java.lang.Boolean Set to true to output the fingerprint in lowercase. Defaults to false, hence uppercase.
outputLLM

Output LLM output.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.outputLLMComponent
Component Class: be.e_contract.ejsf.component.output.llm.OutputLargeLanguageModelComponent
Required Attributes
NameTypeDescription
value java.lang.String The LLM markdown output to display.
Optional Attributes
NameTypeDescription
widgetVar java.lang.String The PrimeFaces widget client-side variable.
outputLanguage

Outputs the language in the language of the language.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.outputLanguage
Component Class: be.e_contract.ejsf.component.output.OutputLanguageComponent
Required Attributes
NameTypeDescription
value java.lang.String The language to output. For example: en
outputMonth

Outputs i18n month.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.outputMonth
Component Class: be.e_contract.ejsf.component.output.OutputMonthComponent
Required Attributes
NameTypeDescription
value java.lang.Integer The month, ranging 1 to 12.
Optional Attributes
NameTypeDescription
omitMonthNumber java.lang.Boolean Set to true to omit the month number.
outputText

Output Text with PrimeFaces widgetVar support.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.outputText
Component Class: be.e_contract.ejsf.component.output.text.OutputTextComponent
Optional Attributes
NameTypeDescription
value java.lang.String The text value to output.
widgetVar java.lang.String The PrimeFaces widget client-side variable.
unit java.lang.String The optional unit.
outputTextEditorHtml

Outputs the HTML generated by the PrimeFaces TextEditor component.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.outputTextEditorHtml
Component Class: be.e_contract.ejsf.component.output.OutputTextEditorHtmlComponent
Required Attributes
NameTypeDescription
value java.lang.String The PrimeFaces TextEditor text value to display.
Optional Attributes
NameTypeDescription
style java.lang.String The optional inline style.
styleClass java.lang.String The optional style class.
outputUrl

Output clickable url.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.outputUrl
Component Class: be.e_contract.ejsf.component.output.OutputUrlComponent
Required Attributes
NameTypeDescription
value java.lang.String The url address.
Optional Attributes
NameTypeDescription
style java.lang.String The optional inline style.
styleClass java.lang.String The optional style class.
label java.lang.String The optional label.
newTab java.lang.Boolean Indicates that the URL should be opened in a new tab.
Client behavior events
click
pages

Show all JSF pages and their visited status.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.pagesComponent
Component Class: be.e_contract.ejsf.component.pages.PagesComponent
passwordValidator

Validator for strong passwords.

Namespace: urn:be:e-contract:ejsf
Optional Attributes
NameTypeDescription
for java.lang.String
performanceNavigation

Performance navigation component.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.performanceNavigationComponent
Component Class: be.e_contract.ejsf.component.performance.PerformanceNavigationComponent
Client behavior events
timing
phoneNumberValidator

Validator for phone numbers.

Namespace: urn:be:e-contract:ejsf
Required Attributes
NameTypeDescription
defaultRegion java.lang.String The default region. For example: BE.
phoneNumberType java.lang.String The type of phone number. Possible values: FIXED_LINE, MOBILE, FIXED_LINE_OR_MOBILE, TOLL_FREE, PREMIUM_RATE, SHARED_COST, VOIP, PERSONAL_NUMBER, PAGER, UAN, VOICEMAIL, UNKNOWN
Optional Attributes
NameTypeDescription
message java.lang.String The optional validation error message.
for java.lang.String
pinValidator

PIN validator.

Namespace: urn:be:e-contract:ejsf
Optional Attributes
NameTypeDescription
minimumDigits java.lang.Integer The optional minimum number of digits. Defaults to 4.
maximumDigits java.lang.Integer The optional maximum number of digits.
message java.lang.String The optional validation error message.
for java.lang.String
plainTextValidator

Plain text validator.

Namespace: urn:be:e-contract:ejsf
Optional Attributes
NameTypeDescription
message java.lang.String The optional validation error message.
allowEmail java.lang.Boolean Set to true to allow email addresses. Defaults to false.
for java.lang.String
platform

A platform to render or not.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.platformComponent
Component Class: be.e_contract.ejsf.component.platform.PlatformComponent
Required Attributes
NameTypeDescription
name java.lang.String The name of the platform: linux, macos, freebsd, or windows
platforms

Renders for a specific platform.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.platformsComponent
Component Class: be.e_contract.ejsf.component.platform.PlatformsComponent
prefixValidator

Prefix validator.

Namespace: urn:be:e-contract:ejsf
Required Attributes
NameTypeDescription
prefix java.lang.String The expected prefix.
Optional Attributes
NameTypeDescription
message java.lang.String The optional validation error message.
for java.lang.String
rateLimiter

Limits the rate at which this field can be processed.

Namespace: urn:be:e-contract:ejsf
Required Attributes
NameTypeDescription
for java.lang.String Indicates the component of which the value is used as base to keep track of tries. Can also be a direct value expression.
Optional Attributes
NameTypeDescription
timeoutDuration java.lang.Integer The optional timeout in seconds when the limit has been reached. Default is 30 seconds.
limitRefreshPeriod java.lang.Integer The optional limit refresh period in seconds over which we keep track of tries. Default is 10 seconds.
limitForPeriod java.lang.Integer The optional limit for the refresh period. Default is 5 tries.
message java.lang.String The optional validation error message.
onLimit java.lang.Object onLimit(java.lang.String) The optional method expression to be invoked when the limit has been reached. The parameter is the identifier used to keep track of the number of tries.
refresh

Refreshes the page.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.refreshComponent
Component Class: be.e_contract.ejsf.component.refresh.RefreshComponent
Optional Attributes
NameTypeDescription
delay java.lang.Integer Sets the delay after which to refresh. Default is 5 seconds.
viewId java.lang.String The optional viewId to which to redirect.
requiresRole

User RBAC validator.

Namespace: urn:be:e-contract:ejsf
Required Attributes
NameTypeDescription
role java.lang.String The required RBAC role.
Optional Attributes
NameTypeDescription
message java.lang.String The optional validation error message.
for java.lang.String
robots

Prevents this page from being indexed by search engines.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.robotsComponent
Component Class: be.e_contract.ejsf.component.robots.RobotsComponent
Optional Attributes
NameTypeDescription
follow java.lang.Boolean Sets follow instead of nofollow.
index java.lang.Boolean Sets index instead of noindex.
sameHeight

Makes all HTML elements embedding this component of the same height.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.sameHeightComponent
Component Class: be.e_contract.ejsf.component.SameHeightComponent
Optional Attributes
NameTypeDescription
group java.lang.String The group name of the elements that should have the same height. Defaults to "default".
serverScript

Server Script component.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.serverScriptComponent
Component Class: be.e_contract.ejsf.component.script.ServerScriptComponent
Optional Attributes
NameTypeDescription
language java.lang.String The script language.
scope java.lang.String The scope of the script. request or view. Defaults to request.
bind java.lang.String Binds EL values to the script.
include java.lang.String Include a script as resource.
functions java.lang.String Marks the script functions.
sessionKeepAlive

Session keep alive component.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.sessionKeepAliveComponent
Component Class: be.e_contract.ejsf.component.session.SessionKeepAliveComponent
Optional Attributes
NameTypeDescription
pingPeriodBeforeExpiry java.lang.Integer Period in seconds before session expiry that we send a ping. Defaults to 30.
maxKeepAlivePeriod java.lang.Integer The maximum period to keep the session alive in minutes. Indefinitely if not defined.
storageClear

Clears the web browser storage.

Namespace: urn:be:e-contract:ejsf
Optional Attributes
NameTypeDescription
type java.lang.String The type of the storage item. 'local' or 'session'. Defaults to 'local'.
storageGetItem

Tag to indicate which storage item to retrieve.

Namespace: urn:be:e-contract:ejsf
Required Attributes
NameTypeDescription
name java.lang.String The name of the storage item.
value java.lang.String The EL for setting the storage item value.
Optional Attributes
NameTypeDescription
type java.lang.String The type of the storage item. 'local' or 'session'. Defaults to 'local'.
storageGetItems

Component to access web browser storage. This component requires JSF version 2.3.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.storageGetItemsComponent
Component Class: be.e_contract.ejsf.component.storage.StorageGetItemsComponent
Optional Attributes
NameTypeDescription
update java.lang.String The components to update.
Client behavior events
items
storageRemoveItem

Removes the item within the web browser storage.

Namespace: urn:be:e-contract:ejsf
Required Attributes
NameTypeDescription
name java.lang.String The name of the storage item.
Optional Attributes
NameTypeDescription
type java.lang.String The type of the storage item. 'local' or 'session'. Defaults to 'local'.
storageSetItem

Sets the item within the web browser storage.

Namespace: urn:be:e-contract:ejsf
Required Attributes
NameTypeDescription
name java.lang.String The name of the storage item.
value java.lang.String The storage item value.
Optional Attributes
NameTypeDescription
type java.lang.String The type of the storage item. 'local' or 'session'. Defaults to 'local'.
tagInfo

Displays the API description of a JSF tag.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.tagInfo
Component Class: be.e_contract.ejsf.component.taginfo.TagInfoComponent
Optional Attributes
NameTypeDescription
library java.lang.String The JSF library. Provide either library or namespace.
namespace java.lang.String The namespace of the JSF library. Provide either library or namespace.
tag java.lang.String The optional JSF tag. If not provided, we display everything.
testComponent

Tests a component.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.testComponentComponent
Component Class: be.e_contract.ejsf.component.test.TestComponentComponent
Required Attributes
NameTypeDescription
library java.lang.String The JSF library.
tag java.lang.String The component tag.
translation

Translation. Child of inlineTranslation.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.translation
Component Class: be.e_contract.ejsf.component.i18n.TranslationComponent
Required Attributes
NameTypeDescription
language java.lang.String The language of this specific translation. For example: nl.
trimConverter

String trimming converter.

Namespace: urn:be:e-contract:ejsf
Optional Attributes
NameTypeDescription
for java.lang.String
trimValidator

Leading/trailing white spaces validator.

Namespace: urn:be:e-contract:ejsf
Optional Attributes
NameTypeDescription
message java.lang.String The optional validation error message.
for java.lang.String
urlValidator

Validator for URLs.

Namespace: urn:be:e-contract:ejsf
Optional Attributes
NameTypeDescription
allowLocalhost java.lang.Boolean Allow localhost URLs.
allowHttp java.lang.Boolean Also allow for HTTP next to HTTPS. Defaults to false.
message java.lang.String The optional validation error message.
for java.lang.String
viewLogs

Component to view the JBoss EAP log files. This requires proper configuration of ViewLogsResourceHandler and ejsf.viewLogs.REQUIRED_ROLE context-param.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.viewLogsComponent
Component Class: be.e_contract.ejsf.component.viewlogs.ViewLogsComponent
Optional Attributes
NameTypeDescription
style java.lang.String The optional inline style.
styleClass java.lang.String The optional style class.
newTab java.lang.Boolean Indicates that the log should be opened in a new tab.
dateTimePattern java.lang.String The datetime formatter pattern.
viewLogsExclude

Exclude filter for viewLogs.

Namespace: urn:be:e-contract:ejsf
Required Attributes
NameTypeDescription
name java.lang.String The regular expression to filter log file names.
viewLogsInclude

Include filter for viewLogs.

Namespace: urn:be:e-contract:ejsf
Required Attributes
NameTypeDescription
name java.lang.String The regular expression to filter log file names.
visNetwork

Component for VIS Network.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.visNetworkComponent
Component Class: be.e_contract.ejsf.component.output.visnetwork.VisNetworkComponent
Required Attributes
NameTypeDescription
value java.lang.String The VIS Network data JSON structure.
Optional Attributes
NameTypeDescription
width java.lang.Integer The optional width of the network. Defaults to 600. Ignored if style or styleClass is set.
height java.lang.Integer The optional height of the network. Defaults to 400. Ignored if style or styleClass is set.
widgetVar java.lang.String The PrimeFaces widget client-side variable.
style java.lang.String The optional inline style.
styleClass java.lang.String The optional style class.
Client behavior events
doubleClick
webAuthn

The WebAuthn component.

Namespace: urn:be:e-contract:ejsf
Component Type: ejsf.webAuthnComponent
Component Class: be.e_contract.ejsf.component.webauthn.WebAuthnComponent
Required Attributes
NameTypeDescription
credentialRepository com.yubico.webauthn.CredentialRepository The CredentialRepository.
relyingPartyId java.lang.String The relying party identifier.
relyingPartyName java.lang.String The relying party name.
username java.lang.String The username.
Optional Attributes
NameTypeDescription
allowOriginPort java.lang.Boolean Allow any origin port.
Client behavior events
registered
authenticated
error
webAuthnAuthenticate

WebAuthn Authenticate action.

Namespace: urn:be:e-contract:ejsf
Optional Attributes
NameTypeDescription
for java.lang.String The optional webAuthn component.
webAuthnAuthentication

WebAuthn authentication AJAX behavior.

Namespace: urn:be:e-contract:ejsf
Required Attributes
NameTypeDescription
listener void listener(be.e_contract.ejsf.component.webauthn.WebAuthnAuthenticatedEvent) Method to invoke after authentication.
Optional Attributes
NameTypeDescription
update java.lang.String Components to update.
userVerification java.lang.String User verification requirements. "required", "preferred", or "discouraged".
timeout java.lang.Long The WebAuthn timeout in milliseconds.
prfListener com.yubico.webauthn.data.ByteArray prfListener(com.yubico.webauthn.data.ByteArray) Method to invoke for PRF functionality.
errorListener void errorListener(be.e_contract.ejsf.component.webauthn.WebAuthnAuthenticationError) Method to invoke upon authentication error.
messageInterceptor java.lang.String messageInterceptor(java.lang.String,java.lang.String) Authentication message interceptor.
webAuthnRegister

WebAuthn Registration action.

Namespace: urn:be:e-contract:ejsf
Optional Attributes
NameTypeDescription
for java.lang.String The optional webAuthn component.
webAuthnRegistration

WebAuthn registration AJAX behavior.

Namespace: urn:be:e-contract:ejsf
Required Attributes
NameTypeDescription
listener void listener(be.e_contract.ejsf.component.webauthn.WebAuthnRegisteredEvent) Method to invoke after registration.
Optional Attributes
NameTypeDescription
update java.lang.String Components to update.
userId byte[] The optional userId as byte[]. If none is provided, a userId gets generated.
userDisplayName java.lang.String The optional user display name. If none is provided, we use the username instead.
userVerification java.lang.String User verification requirements. "required", "preferred", or "discouraged".
timeout java.lang.Long The WebAuthn timeout in milliseconds.
authenticatorAttachment java.lang.String Authenticator attachment. "platform" or "cross-platform".
residentKey java.lang.String Resident key requirements. "required", "preferred", or "discouraged".
attestationTrustSource com.yubico.webauthn.attestation.AttestationTrustSource The Attestation Trust Store.
attestationConveyance java.lang.String The Attestation Conveyance Preference. "none", "indirect", "direct", or "enterprise".
allowUntrustedAttestation java.lang.Boolean Allow for untrusted attestations. Defaults to true.
errorListener void errorListener(be.e_contract.ejsf.component.webauthn.WebAuthnRegistrationError) Method to invoke upon registration error.
messageInterceptor java.lang.String messageInterceptor(java.lang.String,java.lang.String) Registration message interceptor.
webAuthnUsernameValidator

WebAuthn Username Validator.

Namespace: urn:be:e-contract:ejsf
Required Attributes
NameTypeDescription
mode java.lang.String Validation mode. "registration" or "authentication"
credentialRepository com.yubico.webauthn.CredentialRepository The CredentialRepository.
Optional Attributes
NameTypeDescription
message java.lang.String The optional validation error message.
xmlValidator

Validator for XML input.

Namespace: urn:be:e-contract:ejsf
Optional Attributes
NameTypeDescription
message java.lang.String The optional validation error message.
for java.lang.String
Functions
getRateLimiterSessionIdentifier

Name: getRateLimiterSessionIdentifier
Class: be.e_contract.ejsf.validator.ratelimiter.RateLimiterFunctions
Signature: java.lang.String getRateLimiterSessionIdentifier(java.lang.String)