public class org.jfxtras.scene.control.XTreeView

Inherits from: javafx.scene.control.Control > org.jfxtras.scene.control.XTreeView javafx.scene.control.Control, javafx.scene.layout.Resizable,

Known subclasses:

Jump to Section:
overview
variables
functions

Overview

Reppresents a Tree control

Variable Summary

access	name	type	description
public	baseIndent	Number	The indent from the parent level.
public	bottomPadding	Integer	Padding on the bottom side of tree nodes. Padding on the bottom side of tree nodes. Overrides the default padding value if set.
	context	FXContext
public	dataDescriptor	TreeDataDescriptor	The XTreeView Data Descriptor
public	dataProvider	DataProvider	The Data Provider for the tree nodes
package	defaultRenderers	XMap
public	getCollapsedGraphic	function():Node	Function to create the collapsed graphic
public	getExpandedGraphic	function():Node	Function to create the expanded graphic
public	isSelectionEvent	function(:XTreeNode,:MouseEvent):boolean	Function to determine if a mouse event represents a selection event. Function to determine if a mouse event represents a selection event. Default behavior is primaryButtonDown and clickCount <= 1
public	leftPadding	Integer	Padding on the left side of tree nodes. Padding on the left side of tree nodes. Overrides the default padding value if set.
public	onCollapse	function(:XTreeNode):Void	Function called when tree node is collapsed
public	onExpand	function(:XTreeNode):Void	Function called when tree node is expanded
public	onKeyPressedNode	function(:XTreeNode,:KeyEvent):Void	Defines a function to be called when a key is pressed on a `XTreeNode`.
public	onKeyReleasedNode	function(:XTreeNode,:KeyEvent):Void	Defines a function to be called when a key is released on a `XTreeNode`.
public	onKeyTypedNode	function(:XTreeNode,:KeyEvent):Void	Defines a function to be called when a key is typed on a `XTreeNode`.
public	onMouseClickedNode	function(:XTreeNode,:MouseEvent):Void	Defines a function to be called when the mouse clicks on a `XTreeNode`.
public	onMouseDraggedNode	function(:XTreeNode,:MouseEvent):Void	Defines a function to be called when the mouse drags a `XTreeNode`.
public	onMouseEnteredNode	function(:XTreeNode,:MouseEvent):Void	Defines a function to be called when the mouse enters a `XTreeNode`.
public	onMouseExitedNode	function(:XTreeNode,:MouseEvent):Void	Defines a function to be called when the mouse exits a `XTreeNode`.
public	onMouseMovedNode	function(:XTreeNode,:MouseEvent):Void	Defines a function to be called when the mouse moves while on a `XTreeNode`.
public	onMousePressedNode	function(:XTreeNode,:MouseEvent):Void	Defines a function to be called when the mouse is pressed on a `XTreeNode`.
public	onMouseReleasedNode	function(:XTreeNode,:MouseEvent):Void	Defines a function to be called when the mouse si released on a `XTreeNode`.
public	onMouseWheelMovedNode	function(:XTreeNode,:MouseEvent):Void	Defines a function to be called when the mouse wheel is moved over a `XTreeNode`.
public	onSelection	function(:XTreeNode):Void	Function called when tree node is selected
public	padding	Integer	The default padding around tree nodes. The default padding around tree nodes. Can be overriden on each side by setting the more specific padding variable.
public	rightPadding	Integer	Padding on the right side of tree nodes. Padding on the right side of tree nodes. Overrides the default padding value if set.
public	rootVisible	Boolean	Indicates whether the root node is visible or not
public	selected	XTreeNode	The current selected node
public	topPadding	Integer	Padding on the top side of tree nodes. Padding on the top side of tree nodes. Overrides the default padding value if set.
package	treeDirty	Integer	flag to track whether the tree nodes need to be rebuilt or not
	treeSkin	XTreeSkin

Inherited Variables

Function Summary

public addRenderer(clazz: java.lang.Class, renderer: NodeRenderer) : Void

Add a custom renderer

clazz: the class to map to the renderer
renderer: the renderer

public addRenderer(type: javafx.reflect.FXType, renderer: NodeRenderer) : Void

Add a custom renderer

type: the FXType to map to the renderer
renderer: the renderer

package clearDirty() : Integer

clear the dirty setting

Integer

public clearSelection() : XTreeNode

XTreeNode

public collapsePath(node: XTreeNode) : Void

node

public collapseSelection() : Void

public expandPath(node: XTreeNode) : Void

node

public expandSelection() : Void

package getBottomPad() : Integer

Integer

package getLeftPad() : Integer

Integer

package getRightPad() : Integer

Integer

public getRoot() : XTreeNode

Get the root node

XTreeNode

package getTopPad() : Integer

Integer

public hasBeenExpanded(node: XTreeNode) : Boolean

node

Boolean

public isCollapsed(node: XTreeNode) : Boolean

node

Boolean

public isExpanded(node: XTreeNode) : Boolean

node

Boolean

package isInterestedInKeyEvents() : Boolean

Indicates whether or not the tree is interested in key events.

Boolean

public isVisible(node: XTreeNode) : Boolean

node

Boolean

public makeVisible(node: XTreeNode) : Void

node

package markDirty() : Integer

mark the tree as dirty

Integer

public removeRenderer(clazz: java.lang.Class) : Void

remove a custom renderer

clazz: the class that maps to the renderer

public removeRenderer(type: javafx.reflect.FXType) : Void

remove a custom renderer

type: the FXType that maps to the renderer

public reset() : Void

Reset the root node to null

Profile: desktop, common