[richfaces-planning-issues] [JBoss JIRA] Commented: (RFPL-984) Tree: documentation review and promotion

[Ilya Shaikovsky (JIRA)]

    [ https://issues.jboss.org/browse/RFPL-984?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12576459#comment-12576459 ] 

Ilya Shaikovsky commented on RFPL-984:
--------------------------------------

Tree

1) Description:
"The <rich:tree> component provides a hierarchical tree control. Each <rich:tree> component typically consists of <rich:treeNode> child components. The appearance and behavior of the tree and its nodes can be fully customized."

treeNodes actually just a components which used to define markup for tree node of particular type. So not sure about consist of. Devs could just understand that them could be used in a static way. I prefer "Each <rich:tree> component typically consists of set of tree nodes which rendered using one of the <r:treeNode> according to node types"


2) For basic usage, the <rich:tree> component needs one or more <rich:treeNode> components to work with the data model.

actually if no nodes provided - tree will create default nodes on its own. E.g. first samples will works fine even without treeNode.

In general the mechanism:
*if nodeType attribute exist and resolved to some type and user not present any nodes - nothing will be rendered
*But if there is no nodetype and no nodes - tree will construct default node
*And if there is nodetype and set of nodes and there is one node without type - it will be used as default node when other does not contains one of current iterated node type.

3) nodeFace -> nodeType (check snippets)
4) icons attributes - inconExpanded, iconCollapsed, iconLeaf. I see no just icon now. And see no facets for now.

5)Expanding and collapsing tree nodes attributes:
toggleType - client ajax server
toggleNodeEvent - e.g. click(def), mouseover

6) - please ask Nick to check the small section "12.1.3.1. Identifying nodes". 

7) No built-in dnd in tree for now. 
7.1) So remove corresponding event attributes.
7.2) current client side 
*onnodetoggle onbeforenodetoggle
*onselectionchange onbeforeselectionchange
+ ajax events attributes

7.3) server side
+selectionChangeListener
+toggleListener
-dnd listeners

To Add:
I think that would be good to highlight selection to separate section and cover selectionType mode attribute and provide simple listener sample.

TreeNode:
1) from description "but should contain the content of the nodes." again that confuses me to think that nodes could be static. Please think about rephrase to talk about "nodes provides markup templates for tree nodes of particular type"
2) "icon" mentioned again. but there is only iExp.., iCollapsed and iLeaf
3)"All interactivity with individual nodes, such as expanding and collapsing, drag-and-drop, and other events handling, is managed by the parent <rich:tree> component. Refer to Section 12.1.3, “Expanding and collapsing tree nodes” and Section 12.1.4, “Event handling” for further details."
just minor comment on that - in future much of fucntionality will be allowed to be redefined at treeNode level. So need to update that after.

To ADD:
1) no more advisors!(not write it) :) finally treeNode has simple "expanded" attribute which could be used instead of writing java code for advisor as for 3.3.x

GENERAL TREE CHAPTER TO ADD:
Adaptors should be covered. Do you have tasks for that?

> Tree: documentation review and promotion
> ----------------------------------------
>
>                 Key: RFPL-984
>                 URL: https://issues.jboss.org/browse/RFPL-984
>             Project: RichFaces Planning
>          Issue Type: Task
>      Security Level: Public(Everyone can see) 
>          Components: components, doc
>    Affects Versions: 4.0.0.Milestone4
>            Reporter: Nick Belaevski
>            Assignee: Ilya Shaikovsky
>             Fix For: 4.0.0.CR1
>
>
> Please review the documentation:
> http://docs.jboss.org/richfaces/nightly_4_0_X/Component_Reference/en-US/html_single/#sect-Component_Reference-Trees-richtree

-- 
This message is automatically generated by JIRA.
-
For more information on JIRA, see: http://www.atlassian.com/software/jira