Class f_tree

Object
  f_object
      f_eventTarget
          f_component
              f_tree

All Implemented Interfaces:

Element, fa_autoOpen, fa_autoScroll, fa_cardinality, fa_checkManager, fa_clientData, fa_clientFullState, fa_disabled, fa_draggable, fa_droppable, fa_eventTarget, fa_filterProperties, fa_immediate, fa_itemClientDatas, fa_itemsManager, fa_overStyleClass, fa_readOnly, fa_scrollPositions, fa_selectionManager, fa_selectionProvider, fa_serializable, fa_subMenu, HTMLElement, Node

public class f_tree
extends f_component
implements fa_subMenu, fa_autoOpen, fa_disabled, fa_autoScroll, fa_droppable, fa_scrollPositions, fa_itemClientDatas, fa_overStyleClass, fa_filterProperties, fa_readOnly, fa_immediate, fa_checkManager, fa_selectionManager, fa_draggable

f_tree

Field Summary

Fields inherited from class fa_selectionManager

BEGIN_PHASE, END_PHASE

Fields inherited from class fa_cardinality

ONEMANY_CARDINALITY, ONE_CARDINALITY, OPTIONAL_CARDINALITY, ZEROMANY_CARDINALITY

Fields inherited from class fa_clientFullState

NONE_CLIENT_FULL_STATE, ONEWAY_CLIENT_FULL_STATE, TWOWAYS_CLIENT_FULL_STATE

Fields inherited from class f_component

DEFAULT_HIDDEN_MODE, HIDDEN_MODE_IGNORE, HIDDEN_MODE_PHANTOM, HIDDEN_MODE_SERVER

Fields inherited from class HTMLElement

className, dir, id, lang

Fields inherited from class Element

tagName

Fields inherited from class Node

childNodes, firstChild, lastChild, nextSibling, nodeName, nodeType, nodeValue, ownerDocument, parentNode, previousSibling

Method Summary

Object	f_appendNode(Object parent, String label, String value, String tooltip, any disabled)
boolean	f_check(any value, boolean show) Check a node.
boolean	f_closeNode(any value) Close a node.
any	f_forEachNode(Function callBack, any parent) Call a callback for each loaded node.
boolean	f_getChecked(any value) Returns the check state of a node.
Number	f_getDragEffects(any selection)
Array	f_getDragItems(any selection)
Array	f_getDragItemsElement(any selection)
Array	f_getDragItemsValue(any selection)
Array	f_getDragTypes(any selection)
String	f_getElementLabel(any value) Returns label of a node
String[]	f_getHierachicalValues(any value)
String	f_getItemDepth(Object nodeOrValue)
String	f_getItemImage(Object nodeOrValue) Returns image of a node
String	f_getItemLabel(Object nodeOrValue) Returns label of a node
String	f_getItemStyleClass(Object nodeOrValue)
Object	f_getNodeByValue(any value) Search a node by a specified value.
String	f_getNodeLabel(any value) Returns the label of a node.
any	f_getNodeValue(Object node) Returns the value of a node.
Object	f_getParentNode(Object node)
boolean	f_isNodeDisabled(any value) Returns the disable state of a node.
boolean	f_isOpened(any value) Returns the expand state of a node.
boolean	f_isSelected(any value) Returns the selection state of a node.
Object[]	f_listChildrenValues(any value) Returns the value of each children of a node.
boolean	f_mapHierarchicalValues(Function callback, any value)
boolean	f_openNode(any value) Open a node.
void	f_refreshContent(any value) Refresh the structure of the tree.
boolean	f_revealAndSelectNode(any value)
boolean	f_revealNode(any value)
boolean	f_select(any value, boolean append, boolean show) Select a node
void	f_setDisabledNodeImageURL(Object node, String imageURL)
void	f_setExpandedNodeImageURL(Object node, String imageURL)
void	f_setItemStyleClass(Object nodeOrValue, String styleClass)
void	f_setNodeDisabled(any value, any disabled) Disable or enable a tree node.
void	f_setNodeImageURL(Object node, String imageURL)
void	f_setSelectedNodeImageURL(Object node, String imageURL)
boolean	f_showNode(any value) Show a node.
boolean	f_uncheck(any value) Uncheck a node.

Methods inherited from class fa_subMenu

f_getSubMenuById, f_listSubMenus

Methods inherited from class fa_autoOpen

fa_findAutoOpenElement

Methods inherited from class fa_disabled

f_isDisabled, f_setDisabled

Methods inherited from class fa_droppable

f_isDroppable, f_outDropInfos, f_overDropInfos, f_queryDropInfos, f_releaseDropInfos

Methods inherited from class fa_scrollPositions

f_getHorizontalScrollPosition, f_getVerticalScrollPosition, f_setHorizontalScrollPosition, f_setVerticalScrollPosition

Methods inherited from class fa_itemClientDatas

f_getItemByValue, f_getItemClientData, f_getItemClientDatas, f_setItemClientData

Methods inherited from class fa_overStyleClass

f_getOverStyleClass

Methods inherited from class fa_filterProperties

f_getFilterProperties, f_setFilterProperties, f_setFilterProperty

Methods inherited from class fa_readOnly

f_isReadOnly, f_setReadOnly

Methods inherited from class fa_immediate

f_isImmediate

Methods inherited from class fa_checkManager

f_getCheckedValues, f_setCheckedValues

Methods inherited from class fa_selectionManager

f_getSelection, f_setSelection

Methods inherited from class fa_selectionProvider

f_getSelection, f_setSelection

Methods inherited from class fa_draggable

f_getDragEffects, f_getDragItems, f_getDragItemsElement, f_getDragItemsValue, f_getDragTypes, f_isDraggable

Methods inherited from class f_component

f_findComponent, f_findSiblingComponent, f_getAccessKey, f_getBackgroundColor, f_getDocument, f_getForegroundColor, f_getHeight, f_getHelpMessage, f_getHelpURL, f_getHiddenMode, f_getId, f_getParent, f_getToolTipText, f_getVisible, f_getWidth, f_getX, f_getY, f_isVisible, f_setBackgroundColor, f_setFocus, f_setForegroundColor, f_setHeight, f_setHelpMessage, f_setHelpURL, f_setHiddenMode, f_setToolTipText, f_setVisible, f_setWidth, f_setX, f_setY, f_show, toString

Methods inherited from class fa_clientData

f_getClientData, f_getClientDataSet, f_getClientDatas, f_setClientData

Methods inherited from class fa_eventTarget

f_addEventListener, f_fireEvent, f_removeEventListener

Methods inherited from class Element

getAttribute, getElementsByTagName, removeAttribute, setAttribute

Methods inherited from class Node

appendChild, hasChildNodes, insertBefore, removeChild, replaceChild

Methods inherited from class f_object

f_getClass, toString

Methods inherited from class Object

toString

Method Detail

f_getDragEffects

public Number f_getDragEffects(any selection)

f_getDragItems

public Array f_getDragItems(any selection)

f_refreshContent

public void f_refreshContent(any value)

Refresh the structure of the tree.

Parameters:

value - Value of the node, or the node object.

f_listChildrenValues

public Object[] f_listChildrenValues(any value)

Returns the value of each children of a node.

Parameters:

value - Value of the node, or the node object.

Returns:

value of each children nodes.

f_revealNode

public boolean f_revealNode(any value)

Parameters:

value - Value of the node, or the node object

Returns:

true if the node was found.

f_uncheck

public boolean f_uncheck(any value)

Uncheck a node.

Parameters:

value - Value of the node

Returns:

true if success.

f_closeNode

public boolean f_closeNode(any value)

Close a node.

Parameters:

value - Value of the node, or the node object.

Returns:

true if success.

f_openNode

public boolean f_openNode(any value)

Open a node.

Parameters:

value - Value of the node, or the node object

Returns:

true if success.

f_check

public boolean f_check(any value,
                       boolean show)

Check a node.

Parameters:

value - Value of the node

show - Node must be show after the selection.

Returns:

true if success !

f_isOpened

public boolean f_isOpened(any value)

Returns the expand state of a node.

Parameters:

value - Value of the node, or the node object.

Returns:

true if the node is expanded. (open)

f_showNode

public boolean f_showNode(any value)

Show a node.

Parameters:

value - Value of the node, or the node object

Returns:

true if the node was found.

f_getParentNode

public Object f_getParentNode(Object node)

Parameters:

node -

Returns:

node

f_getHierachicalValues

public String[] f_getHierachicalValues(any value)

Parameters:

value - The value of a node or an element object (Use cursor value if not specified)

Returns:

Returns Hierarchical values which are opened.

f_isNodeDisabled

public boolean f_isNodeDisabled(any value)

Returns the disable state of a node.

Parameters:

value - Value of the node, or the node object.

f_appendNode

public Object f_appendNode(Object parent,
                           String label,
                           String value,
                           String tooltip,
                           any disabled)

Parameters:

parent - Parent node. (or the tree object itself if the node is the root)

label -

value -

tooltip -

Returns:

Boolean disabled

f_getNodeByValue

public Object f_getNodeByValue(any value)

Search a node by a specified value.

Parameters:

value - Value of the node.

Returns:

found node.

f_getItemImage

public String f_getItemImage(Object nodeOrValue)

Returns image of a node

Parameters:

nodeOrValue -

Returns:

url of an image

f_getItemStyleClass

public String f_getItemStyleClass(Object nodeOrValue)

Parameters:

nodeOrValue -

f_setExpandedNodeImageURL

public void f_setExpandedNodeImageURL(Object node,
                                      String imageURL)

Parameters:

node -

imageURL -

f_revealAndSelectNode

public boolean f_revealAndSelectNode(any value)

Parameters:

value - Value of the node, or the node object

Returns:

true if the node was found.

f_setSelectedNodeImageURL

public void f_setSelectedNodeImageURL(Object node,
                                      String imageURL)

Parameters:

node -

imageURL -

f_setNodeDisabled

public void f_setNodeDisabled(any value,
                              any disabled)

Disable or enable a tree node.

Parameters:

value - Value of the node, or the node object.

f_setNodeImageURL

public void f_setNodeImageURL(Object node,
                              String imageURL)

Parameters:

node -

imageURL -

f_getDragItemsValue

public Array f_getDragItemsValue(any selection)

f_setItemStyleClass

public void f_setItemStyleClass(Object nodeOrValue,
                                String styleClass)

Parameters:

nodeOrValue -

styleClass -

f_isSelected

public boolean f_isSelected(any value)

Returns the selection state of a node.

Parameters:

value - Value of the node, or the node object.

Returns:

true if the node is selected.

f_getNodeLabel

public String f_getNodeLabel(any value)

Returns the label of a node.

Parameters:

value - Value of the node, or the node object.

f_getChecked

public boolean f_getChecked(any value)

Returns the check state of a node.

Parameters:

value - Value of the node, or the node object.

Returns:

true if the node is checked.

f_getDragItemsElement

public Array f_getDragItemsElement(any selection)

f_setDisabledNodeImageURL

public void f_setDisabledNodeImageURL(Object node,
                                      String imageURL)

Parameters:

node -

imageURL -

f_getDragTypes

public Array f_getDragTypes(any selection)

f_mapHierarchicalValues

public boolean f_mapHierarchicalValues(Function callback,
                                       any value)

Parameters:

callback -

value - The value of a node or an element object (Use cursor value if not specified)

f_select

public boolean f_select(any value,
                        boolean append,
                        boolean show)

Select a node

Parameters:

value - Value of the node.

append - Append mode.

show - Node must be show after the selection.

Returns:

true if success.

f_getElementLabel

public String f_getElementLabel(any value)

Returns label of a node

Parameters:

value -

See Also:

#f_getItemLabel(nodeOrValue)

f_getNodeValue

public any f_getNodeValue(Object node)

Returns the value of a node.

Parameters:

node - Node object.

Returns:

Value of the node.

f_getItemDepth

public String f_getItemDepth(Object nodeOrValue)

Parameters:

nodeOrValue -

f_forEachNode

public any f_forEachNode(Function callBack,
                         any parent)

Call a callback for each loaded node.

Parameters:

callBack - Callback called for each node !

f_getItemLabel

public String f_getItemLabel(Object nodeOrValue)

Returns label of a node

Parameters:

nodeOrValue -