Options
All
  • Public
  • Public/Protected
  • All
Menu

The configuration for the BaseTree widget. You can access this configuration via BaseWidget.cfg. Please note that this configuration is usually meant to be read-only and should not be modified.

Hierarchy

Index

Properties

animate: boolean

true is the tree is animated, or false otherwise.

behaviors: Record<string, Behavior>

A map with all behaviors that were defined for this widget. The key is the name of the behavior, the value is the callback function that is invoked when the behavior is called.

cache: boolean

true if the content of dynamically loaded nodes is cached for the next time the node is expanded, or false to always fetch the content from the server.

disabled: boolean

true is this widget is disabled, or false otherwise.

Defines parent-child relationship when a node is dragged.

dragdropScope: string

Optional scope for the dragging and dropping, passed to JQuery UI.

draggable: boolean

true if nodes are draggable, or false otherwise.

dropCopyNode: boolean

When enabled, the copy of the selected nodes can be dropped from a tree to another tree using Shift key.

droppable: boolean

true if nodes are droppable, or false otherwise.

dynamic: boolean

true if the content of nodes is loaded dynamically as needed, or false otherwise.

event: string

Event for the context menu.

filter: boolean

true if filtering is enabeld, false otherwise.

filterMode: FilterMode

Mode for filtering.

formId?: string

ID of the form to use for AJAX requests.

highlight: boolean

true if selected nodes are highlighted, or false otherwise.

iconStates: Record<string, NodeIconSet>

A map between the type of a node and the icons for that node.

id: string | string[]

The client-side ID of the 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.

multipleDrag: boolean

When enabled, the selected multiple nodes can be dragged from a tree to another tree.

nodeType: string

Node type of nodes for which the context menu is available.

onNodeClick: OnNodeClickCallback

Callback that is invoked when a node is clicked. If it returns false, the click on the node is ignored.

postConstruct: PostConstructCallback

An optional callback that is invoked after this widget was created successfully, at the end of the init method. This is usually specified via the widgetPostConstruct attribute on the JSF component. Note that this is also called during a refresh (AJAX update).

postRefresh: PostRefreshCallback

An optional callback that is invoked after this widget was refreshed after an AJAX update, at the end of the refresh method. This is usually specified via the widgetPostRefresh attribute on the JSF component.

preDestroy: PreDestroyCallback

An optional callback that is invoked before this widget is about to be destroyed, e.g., when the component was removed at the end of an AJAX update. This is called at the beginning of the destroy method. This is usually specified via the widgetPreDestroy attribute on the JSF component.

propagateDown: boolean

Whether toggling a node checkbox is propagated downwards.

propagateUp: boolean

Whether toggling a node checkbox is propagated upwards.

How the node of this tree can be selected, if selection is enabled at all.

widgetVar: string

The name of the widget variables of this widget. The widget variable can be used to access a widget instance by calling PF("myWidgetVar").

Generated using TypeDoc