Defaults to VerticalTreeCfg. Type of the configuration object for this widget.
Creates a new instance of this widget. Please note that you should NOT override this constructor. Instead, override the init method, which is called at the end of the constructor once the instance is created.
The widget configuration to be used for this widget
instance. This widget configuration is usually created on the server by the javax.faces.render.Renderer for
this component.
The configuration of this widget instance. Please note that
no property is guaranteed to be present, you should always check for undefined before accessing a property.
This is partly because the value of a property is not transmitted from the server to the client when it equals
the default.
The DOM element for the tree container.
When multiple nodes are selected, the selected node on which the user clicked most recently.
Array of registered listeners invoked when this widget is destroyed. You should normally not use modify this directly, use addDestroyListener instead.
List of parameter describing the drag & drop operations.
The DOM element for the filter input field that lets the user search the tree.
The set-timeout timer ID of the timer for the filter delay.
DOM element of the node which is currently focused, if any.
The client-side ID of this widget, with all parent naming containers, such as
myForm:myWidget. This is also the ID of the container HTML element for this widget. In case the widget needs
multiple container elements (such as Paginator), this may also be an array if IDs.
A list of row keys for rows that are not valid drag sources.
The jQuery instance of the container element of this widget. In case id is an array, it will contain multiple elements. Please note that some widgets have got not DOM elements at all, in this case this will be an empty jQuery instance.
A CSS selector for the container element (or elements, in case id is an array) of
this widget, This is usually an ID selector (that is properly escaped). You can select the container element or
elements like this: $(widget.jqId).
Target of the context menu, when a context menu is used.
Array of registered listeners invoked when this widget is refreshed. You should normally not use modify this directly, use addRefreshListener instead.
The set-interval time ID of the timer for scrolling.
Form element that holds the current scroll state.
DOM element of the hidden form element that holds the list of selected nodes.
List of nodes which are currently selected. Each item is the row key of a selected node.
For drag&drop, whether the shift is pressed.
The name of the widget variables of this widget. The widget variable can be used to
access a widget instance by calling PF('myWidgetVar').
Lets you register a listener that is called before the component is destroyed.
When an AJAX call is made and this component is updated, the DOM element is replaced with the newly rendered content. When the element is removed from the DOM by the update, the DOM element is detached from the DOM and all destroy listeners are called. This makes it possible to add listeners from outside the widget code.
If you call this method twice with the same listener, it will be registered twice and later also called twice.
Note that for this to work, you must not override the destroy method; or if you do, call super.
Also, after this widget was detached is done, all destroy listeners will be unregistered.
A destroy listener to be registered.
When an AJAX call is made and this component is updated, the DOM element is replaced with the newly rendered content. However, no new instance of the widget is created. Instead, after the DOM element was replaced, all refresh listeners are called. This makes it possible to add listeners from outside the widget code.
If you call this method twice with the same listener, it will be registered twice and later also called twice.
Note that for this to work, you must not override the refresh method; or if you do, call super.
Also, after the refresh is done, all refresh listeners will be deregistered. If you added the listeners from
within this widget, consider adding the refresh listeners not only in the init method, but also again in
the refresh method after calling super.
A refresh listener to be registered.
Adds the given node to the list of selected nodes.
Row key of the node to add to the selected nodes.
Callback that is invoked when the context menu is initialized. Lets the context menu provider register the appropriate event listeners for when the context menu should be shown and hidden.
The widget instance of the context menu.
The widget instance of the target widget that wants to add a context menu.
ID selector or DOM element of the target, i.e. the element the context menu belongs to.
The current configuration of the context menu.
A sub class may perform any setup related to registering event handlers in this method, such as listening to mouse clicks or keyboard presses.
Sets up all event listeners for keyboard interactions.
Each widget may have one or several behaviors attached to it. This method calls all attached behaviors for the given event name. In case no such behavior exists, this method does nothing and returns immediately.
A behavior is a way for associating client-side scripts with UI components that opens all sorts of possibilities, including client-side validation, DOM and style manipulation, keyboard handling, and more. When the behavior is triggered, the configured JavaScript gets executed.
Behaviors are often, but not necessarily, AJAX behavior. When triggered, it initiates a request the server
and processes the response once it is received. This enables several features such as updating or replacing
elements dynamically. You can add an AJAX behavior via
<p:ajax event="name" actionListener="#{...}" onstart="..." />.
The name of an event to call.
Additional configuration that is passed to the AJAX request for the server-side callback.
When this tree has got selectable nodes with checkboxes, selects the given checkbox. Does nothing otherwise.
Checkbox of a node to check.
Resets the value of the hidden input field with the current scroll position.
Collapses the given node, as if the user had clicked on the - icon of the node. The children of the node will
now be visible.
Node to collapse.
Will be called after an AJAX request if the widget container will be detached.
When an AJAX call is made and this component is updated, the DOM element is replaced with the newly rendered content. When the element is removed from the DOM by the update, the DOM element is detached from the DOM and this method gets called.
Please note that instead of overriding this method, you should consider adding a destroy listener instead via addDestroyListener. This has the advantage of letting you add multiple listeners, and makes it possible to add additional listeners from code outside this widget.
By default, this method just calls all destroy listeners.
Expands the given node, as if the user had clicked on the + icon of the node. The children of the node will now
be visible.
Node to expand.
Applies the current filter value by sending an AJAX to the server.
Finds the nodes with the given row keys.
A list of row keys.
A list of nodes corresponding to the given row keys, in that order.
Filters the given array of row keys and removes child nodes of parent node in the array.
A list of row keys to check.
A list of parent row keys.
Called when a node was collapsed. Fire the appropriate event.
The node for which to fire the event.
Called when a right click was performed on a node. Fire the appropriate event.
The node for which to fire the event.
Callback that is invoked once the context menu is shown.
Callback for when a drag&drop occurred. Invokes the appropriate behaviors.
Event that triggered the drag&drop.
Called when a node was expanded. Fire the appropriate event.
The node for which to fire the event.
Called when a node was selected. Fire the appropriate event.
The node for which to fire the event.
Called when a node was unselected. Fire the appropriate event.
The node for which to fire the event.
Puts focus on the given node.
A node on which to put focus.
Each widget may have one or several behaviors attached to it. This method returns the callback function for the given event.
Note: Do not call the method directly, the recommended way to invoke a behavior is via callBehavior.
A behavior is a way for associating client-side scripts with UI components that opens all sorts of possibilities, including client-side validation, DOM and style manipulation, keyboard handling, and more. When the behavior is triggered, the configured JavaScript gets executed.
Behaviors are often, but not necessarily, AJAX behavior. When triggered, it initiates a request the server
and processes the response once it is received. This enables several features such as updating or replacing
elements dynamically. You can add an AJAX behavior via
<p:ajax event="name" actionListener="#{...}" onstart="..." />.
The name of an event for which to retrieve the behavior.
The behavior with the given name, or null if no such behavior
exists.
Finds the first node.
The first node of this tree.
Each widget has got a container element, this method returns that container. This container element is usually also the element whose ID is the client-side ID of the JSF component.
The jQuery instance representing the main HTML container element of this widget.
Gets the closest parent form for this widget.
A JQuery instance that either contains the form when found, or an empty JQuery instance when the form could not be found.
Gets the closest parent form ID for this widget lazily so it can be used in AJAX requests.
Either the form ID or undefined if no form can be found.
Finds the row key (unique ID) of the given node.
A node for which to find the row key.
The key of the given node.
Each widget may have one or several behaviors attached to it. This method checks whether this widget has got at least one behavior associated with given event name.
A behavior is a way for associating client-side scripts with UI components that opens all sorts of possibilities, including client-side validation, DOM and style manipulation, keyboard handling, and more. When the behavior is triggered, the configured JavaScript gets executed.
Behaviors are often, but not necessarily, AJAX behavior. When triggered, it initiates a request the server
and processes the response once it is received. This enables several features such as updating or replacing
elements dynamically. You can add an AJAX behavior via
<p:ajax event="name" actionListener="#{...}" onstart="..." />.
The name of an event to check.
true if this widget has the given behavior, false otherwise.
A widget class should not declare an explicit constructor, the default constructor provided by this base widget should be used. Instead, override this initialize method which is called after the widget instance was constructed. You can use this method to perform any initialization that is required. For widgets that need to create custom HTML on the client-side this is also the place where you should call your render method.
Please make sure to call the super method first before adding your own custom logic to the init method:
PrimeFaces.widget.MyWidget = PrimeFaces.widget.BaseWidget.extend({
init: function(cfg) {
this._super(cfg);
// custom initialization
}
});
The widget configuration to be used for this widget instance.
This widget configuration is usually created on the server by the javax.faces.render.Renderer for this
component.
Sets up the drag functionality.
Initializes all drop scrollers of this tree.
Sets up the drop functionality.
Called when this tree is initialized. Performs any setup required for enabling the selection of node.
Checks whether the selection mode of this tree is set to checkbox.
true if the current selection mode is checkbox, or false otherwise.
Checks if this widget is detached, ie whether the HTML element of this widget is currently contained within the DOM (the HTML body element). A widget may become detached during an AJAX update, and it may remain detached in case the update removed this component from the component tree.
true if this widget is currently detached, or false otherwise.
Checks whether this tree is empty, that is, whether it contains any nodes.
true if this tree has got no nodes, or false otherwise.
Checks whether the given node is currently expanded, that is, whether its children are visible.
Node to check.
true if the node is expanded, or false otherwise.
Checks whether the selection mode of this tree is set to multiple.
true if the current selection mode is multiple, or false otherwise.
Checks whether the given node is currently selected, irrespective of the current selection mode.
A node to check.
true if the given node is selected, or false otherwise.
Checks whether the selection mode of this tree is set to single.
true if the current selection mode is single, or false otherwise.
Sets up the JQuery UI draggable for the given elements.
A list of draggable nodes to set up.
Sets up the JQuery UI dropables for the droppable nodes.
List of elements to make droppable.
Sets up the JQuery UI drop points for the given elements.
A list of drop points to set up.
Turns the given node into a leaf node.
A new leaf node to convert.
Turns the given node into a parent node.
A new parent node to convert.
Invoked in response to a normal click on a node.
Event of the click.
Content of the clicked node.
Invoked in response to a right click on a node.
Event of the right click.
Content of the clicked node.
Callback that is invoked when the context menu is shown.
true if the context menu was opened, or false otherwise.
Callback for when a node was dropped.
Details about the drop event.
Tree widget of the dragged node.
Node that was dragged.
Node that was the target of the drag.
The jQUery UI droppable where the drop occurred.
The node on which the dragged node was dropped.
Whether a transfer should occur.
Callback for when a node was dropped on a drop point.
Details about the drop event.
Tree widget of the dragged node.
Node that was dragged.
Node that was the target of the drag.
The drop point where the node was dropped.
The node on which the dragged node was dropped.
Whether a transfer should occur, i.e. whether the node was not dropped on itself.
When this tree has got selectable nodes with checkboxes, partially selects the given checkbox. Does nothing otherwise.
Checkbox of a node to check partially.
Called once during widget initialization if this tree has got nodes with selectable checkboxes.
Updates the drag&drop checkboxes.
Node to which to limit the update.
Used in ajax updates, reloads the widget configuration.
When an AJAX call is made and this component is updated, the DOM element is replaced with the newly rendered content. However, no new instance of the widget is created. Instead, after the DOM element was replaced, this method is called with the new widget configuration from the server. This makes it possible to persist client-side state during an update, such as the currently selected tab.
Please note that instead of overriding this method, you should consider adding a refresh listener instead via addRefreshListener. This has the advantage of letting you add multiple listeners, and makes it possible to add additional listeners from code outside this widget.
By default, this method calls all refresh listeners, then reinitializes the widget by calling the init
method.
The new widget configuration from the server.
The value as returned by the init method, which is often undefined.
Removes all chilren of the given node from the list of currently selected nodes.
Row key of a node to process.
Removes the given node from the list of currently selected nodes.
Row key of a node to to remove from the current selection.
Removes the widget's script block from the DOM. Currently, the ID of this script block consists of the
client-side ID of this widget with the prefix _s, but this is subject to change.
The client-side ID of the widget.
Reads the saved scroll position from the hidden input field and applies it.
Saves the current scroll position to the hidden input field.
Scrolls this tree by the given amount.
Amount by which to scroll.
This method must select the given node. When silent is set to true, no events should be triggered in response
to this action.
A node of this tree to select.
true if no events should be triggered, or false otherwise.
Makes the children of the given node visible. Called when a node is expanded.
Node with children to display.
Updates all checkboxes after a drag&drop.
Tree widget that is the source of the drag, when dragging between two widgets.
Old node that was parent of the dropped node.
New node that is to be the parent of the dropped node.
Updates the tree after a drag&drop event.
Called when the nodes of this tree are selected via checkboxes. Must select the checkbox of the given node.
Node with a checkbox to toggle.
When this tree has got selectable nodes with checkboxes, checks or unchecks the given checkbox.
A checkbox of a node to check or uncheck.
true to check the given node, false to uncheck it.
When this tree has got selectable nodes with checkboxes, unselects the given checkbox. Does nothing otherwise.
Checkbox of a node to uncheck.
This method must unselect all nodes of this tree that are selected.
This method must unselect the given node. When silent is set to true, no events should be triggered in
response to this action.
A node of this tree to unselect.
true if no events should be triggered, or false otherwise.
Unselects the node and all child nodes.
Node to unselect.
Updates the row keys of all given children.
List of children to update.
Base prefix for the new rowkey.
Updates the drag&drop settings for the given node.
Node to update.
Updates the row keys of all nodes.
After a drag&drop, validates if the drop is allowed.
Node that was dragged.
Node on which the dragged node was dropped.
Old parent of the dragged node.
Whether the drop is allowed.
Saves the list of currently selected nodes in a hidden form element.
Generated using TypeDoc
PrimeFaces Vertical Tree Widget
Tree is used for displaying hierarchical data and creating a site navigation. This implements a vertical tree.