docs/Script API/interfaces/Frontend_Script_API._internal_.FancytreeEvents.html
The this context of any event function is set to tree's the HTMLDivElement
interface FancytreeEvents {
rtl?: boolean;
activate(event: JQueryEventObject, data: EventData): void;
beforeActivate(event: JQueryEventObject, data: EventData): boolean;
beforeExpand(event: JQueryEventObject, data: EventData): boolean;
beforeSelect(event: JQueryEventObject, data: EventData): boolean;
blur(event: JQueryEventObject, data: EventData): void;
blurTree(event: JQueryEventObject, data: EventData): void;
click(event: JQueryEventObject, data: EventData): boolean;
collapse(event: JQueryEventObject, data: EventData): void;
create(event: JQueryEventObject, data: EventData): void;
createNode(event: JQueryEventObject, data: EventData): void;
dblclick(event: JQueryEventObject, data: EventData): boolean;
deactivate(event: JQueryEventObject, data: EventData): void;
expand(event: JQueryEventObject, data: EventData): void;
focus(event: JQueryEventObject, data: EventData): void;
focusTree(event: JQueryEventObject, data: EventData): void;
init(event: JQueryEventObject, data: EventData): void;
keydown(event: JQueryEventObject, data: EventData): boolean;
keypress(event: JQueryEventObject, data: EventData): void;
lazyLoad(event: JQueryEventObject, data: EventData): void;
loadChildren(event: JQueryEventObject, data: EventData): void;
loadError(event: JQueryEventObject, data: EventData): boolean;
postProcess(event: JQueryEventObject, data: EventData): void;
removeNode(event: JQueryEventObject, data: EventData): void;
renderColumns(event: JQueryEventObject, data: EventData): void;
renderNode(event: JQueryEventObject, data: EventData): void;
renderTitle(event: JQueryEventObject, data: EventData): void;
restore(event: JQueryEventObject, data: EventData): void;
select(event: JQueryEventObject, data: EventData): void;
}
activate?beforeActivate?beforeExpand?beforeSelect?blur?blurTree?click?collapse?create?createNode?dblclick?deactivate?expand?focus?focusTree?init?keydown?keypress?lazyLoad?loadChildren?loadError?postProcess?removeNode?renderColumns?renderNode?renderTitle?restore?select?
Optionalrtlrtl?: boolean
Enable RTL version, default is false
Optionalactivateactivate(event: JQueryEventObject, data: EventData): void
'data.node' was deactivated.
OptionalbeforeActivatebeforeActivate(event: JQueryEventObject, data: EventData): boolean
Return false to prevent default processing
OptionalbeforeExpandbeforeExpand(event: JQueryEventObject, data: EventData): boolean
Return false to prevent default processing
OptionalbeforeSelectbeforeSelect(event: JQueryEventObject, data: EventData): boolean
Return false to prevent default processing
Optionalblurblur(event: JQueryEventObject, data: EventData): void
data.node lost keyboard focus
OptionalblurTreeblurTree(event: JQueryEventObject, data: EventData): void
data.tree lost keyboard focus
Optionalclickclick(event: JQueryEventObject, data: EventData): boolean
data.node was clicked. data.targetType contains the region ("title", "expander", ...). Return false to prevent default processing, i.e. activating, etc.
Optionalcollapsecollapse(event: JQueryEventObject, data: EventData): void
data.node was collapsed
Optionalcreatecreate(event: JQueryEventObject, data: EventData): void
Widget was created (called only once, even if re-initialized).
OptionalcreateNodecreateNode(event: JQueryEventObject, data: EventData): void
Allow tweaking and binding, after node was created for the first time (NOTE: this event is only available as callback, but not for bind())
Optionaldblclickdblclick(event: JQueryEventObject, data: EventData): boolean
data.node was double-clicked. data.targetType contains the region ("title", "expander", ...). Return false to prevent default processing, i.e. expanding, etc.
Optionaldeactivatedeactivate(event: JQueryEventObject, data: EventData): void
data.node was deactivated
Optionalexpandexpand(event: JQueryEventObject, data: EventData): void
data.node was expanded
Optionalfocusfocus(event: JQueryEventObject, data: EventData): void
data.node received keyboard focus
OptionalfocusTreefocusTree(event: JQueryEventObject, data: EventData): void
data.tree received keyboard focus
Optionalinitinit(event: JQueryEventObject, data: EventData): void
Widget was (re-)initialized.
Optionalkeydownkeydown(event: JQueryEventObject, data: EventData): boolean
data.node received key. event.which contains the key. Return false to prevent default processing, i.e. navigation. Call data.result = "preventNav"; to prevent navigation but still allow default handling inside embedded input controls.
Optionalkeypresskeypress(event: JQueryEventObject, data: EventData): void
(currently unused)
OptionallazyLoadlazyLoad(event: JQueryEventObject, data: EventData): void
data.node is a lazy node that is expanded for the first time. The new child data must be returned in the data.result property (see source option for available formats).
OptionalloadChildrenloadChildren(event: JQueryEventObject, data: EventData): void
Node data was loaded, i.e. node.nodeLoadChildren() finished
OptionalloadErrorloadError(event: JQueryEventObject, data: EventData): boolean
A load error occured. Return false to prevent default processing.
OptionalpostProcesspostProcess(event: JQueryEventObject, data: EventData): void
Allows to modify the ajax response.
OptionalremoveNoderemoveNode(event: JQueryEventObject, data: EventData): void
data.node was removed (NOTE: this event is only available as callback, but not for bind())
OptionalrenderColumnsrenderColumns(event: JQueryEventObject, data: EventData): void
(used by table extension)
OptionalrenderNoderenderNode(event: JQueryEventObject, data: EventData): void
Allow tweaking after node state was rendered (NOTE: this event is only available as callback, but not for bind())
OptionalrenderTitlerenderTitle(event: JQueryEventObject, data: EventData): void
Allow replacing the <span class='fancytree-title'> markup (NOTE: this event is only available as callback, but not for bind())
Optionalrestorerestore(event: JQueryEventObject, data: EventData): void
ext-persist has expanded, selected, and activated the previous state
Optionalselectselect(event: JQueryEventObject, data: EventData): void
data.node was selected
Member Visibility
ThemeOSLightDark
Properties rtl Methods activatebeforeActivatebeforeExpandbeforeSelectblurblurTreeclickcollapsecreatecreateNodedblclickdeactivateexpandfocusfocusTreeinitkeydownkeypresslazyLoadloadChildrenloadErrorpostProcessremoveNoderenderColumnsrenderNoderenderTitlerestoreselect