| Info | Value |
|---|---|
| Component Type | org.primefaces.extensions.component.Waypoint |
| Handler Class | None |
| Renderer Type | org.primefaces.extensions.component.WaypointRenderer |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
binding | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
| An EL expression referring to a server side UIComponent instance in a backing bean. |
continuous | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| If true, and multiple waypoints are triggered in one scroll, this waypoint will trigger even if it is not the last waypoint reached. If false, it will only trigger if it is the last waypoint. Default is true. |
enabled | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| If false, this waypoint will be created but will be disabled from triggering. You can call widget's method "enable" to turn it back on. Default is true. |
for | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| The target component registered as waypoint. If null, the parent component will be taken as target. Default is null. |
forContext | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| The context defines which scrollable element the waypoint belongs to and acts within. It can be a component or plain HTML element like a div. Default is window if nothing specified. |
horizontal | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Default waypoints live on the vertical axis. Their offset is calculated in relation to the top of the viewport and they listen for vertical scroll changes. If horizontal is set to true, offset is calculated in relation to the left of the viewport and listens for horizontal scroll changes. For instance, the value 50 means "when the left side of this element reaches 50px from the left side of the viewport". Default is false. |
id | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer. |
offset | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| This option determines how far the top of the element must be from the top of the viewport to trigger a waypoint (callback function). It can be a number, which is taken as a number of pixels (can be also negativ, e.g. -10), a string representing a percentage of the viewport height (e.g. '50%') or a function that will return a number of pixels. Default is 0. |
rendered | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Boolean value to specify the rendering of the component, when set to false component will not be rendered. |
triggerOnce | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| If true, the waypoint will be destroyed when triggered. Default is false. |
widgetVar | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the client side widget. |
Output generated by Vdldoc View Declaration Language Documentation Generator.