5.2.10 Tree

Description:

A Tree is a component with linked elements (nodes) and a hierarchical structure. One common example is the display of directory structures used in most file managers (e.g. Windows Explorer).

Figure 5.17: Tree
Image Tree

Because the forward slash (/) is a special symbol for trees, if you want to use a slash as part of your parameter value, you have to mask it. See the section later in this document 9 for more details.

Mapping trees

In the Object Mapping Mode , a tree to be mapped looks like this:

Figure 5.18: Tree
Image Maptree

\includegraphics[height=2cm]{lightbulb} Actions on trees (as a hierarchical component) are not supported in the HTML toolkit. Individual nodes must be addressed as single links.

Synopsis:

New Actions
Name Type Parameters
Check Existence of Node by Indexpath c

String:Path Type
Integer:Pre-ascend
String:Indexpath
Boolean:Exists

CONCRETE_Tree_VerifyPathByIndices
Check Existence of Node by Textpath c

String:Path Type
Integer:Pre-ascend
String:Textpath
String:Operator
Boolean:Exists

CONCRETE_Tree_VerifyPath
Check Text (Mouse Position) c

String:Text
String:Operator

CONCRETE_Tree_VerifyTextAtMousePosition
Check Text of Selected Node(s) c

String:Text
String:Operator

CONCRETE_Tree_VerifyTextOfSelectedEntry
Collapse Node by Indexpath e

String:Path Type
Integer:Pre-ascend
String:Indexpath

CONCRETE_Tree_CollapseByIndexPath
Collapse Node by Textpath e

String:Path Type
Integer:Pre-ascend
String:Textpath
String:Operator

CONCRETE_Tree_CollapseByTextPath
Drag Node by Indexpath e

Integer:Mouse Button
String:Modifier Keys
String:Path Type
Integer:Pre-ascend
String:Tree Indexpath

CONCRETE_Tree_DragByIndexPath
Drag Node by Textpath e

Integer:Mouse Button
String:Modifier Keys
String:Path Type
Integer:Pre-ascend
String:Tree Textpath
String:Operator

CONCRETE_Tree_DragByTextPath
Drop on Node by Indexpath e

String:Path Type
Integer:Pre-ascend
String:Tree Indexpath
Integer:Delay before drop (milliseconds)

CONCRETE_Tree_DropByIndexPath
Drop on Node by Textpath e

String:Path Type
Integer:Pre-ascend
String:Tree Textpath
String:Operator
Integer:Delay before drop (milliseconds)

CONCRETE_Tree_DropByTextPath
Expand Node by Indexpath e

String:Path Type
Integer:Pre-ascend
String:Indexpath

CONCRETE_Tree_ExpandByIndexPath
Expand Node by Textpath e

String:Path Type
Integer:Pre-ascend
String:Textpath
String:Operator

CONCRETE_Tree_ExpandByTextPath
Move e

String:Direction
Integer:Number of Nodes
Integer:Number of Clicks

CONCRETE_Tree_Move
Select Node by Indexpath e

String:Path Type
Integer:Pre-ascend
String:Indexpath
Integer:Number of Clicks
Integer:Mouse Button
String:Extend Selection

CONCRETE_Tree_SelectByIndexPath
Select Node by Textpath e

String:Path Type
Integer:Pre-ascend
String:Textpath
String:Operator
Integer:Number of Clicks
Integer:Mouse Button
String:Extend Selection

CONCRETE_Tree_SelectByTextPath
Store Text at Mouse Position e

Variable:Variable Name

CONCRETE_Tree_ReadTextAtMousePosition
Store Text of Selected Node e

Variable:Variable Name

CONCRETE_Tree_ReadTextOfSelectedEntry

Inherited Actions
Name Type Parameters Inherited from
Check Enablement c

Boolean:Enabled

Graphics Component (abstract)
Check Enablement of Context Menu Entry by Indexpath c

String:Indexpath
Boolean:Enabled
Integer:Mouse Button

Graphics Component (abstract)
Check Enablement of Context Menu Entry by Indexpath (Specify Position) c

Integer:x-position
String:x-units
Integer:y-position
String:y-units
String:Indexpath
Boolean:Enabled
Integer:Mouse Button

Graphics Component (abstract)
Check Enablement of Context Menu Entry by Textpath c

String:Textpath
String:Operator
Boolean:Enabled
Integer:Mouse Button

Graphics Component (abstract)
Check Enablement of Context Menu Entry by Textpath (Specify Position) c

Integer:x-position
String:x-units
Integer:y-position
String:y-units
String:Textpath
String:Operator
Boolean:Enabled
Integer:Mouse Button

Graphics Component (abstract)
Check Existence c

Boolean:Exists

Graphics Component (abstract)
Check Existence of Context Menu Entry by Indexpath c

String:Indexpath
Boolean:Exists
Integer:Mouse Button

Graphics Component (abstract)
Check Existence of Context Menu Entry by Indexpath (Specify Position) c

Integer:x-position
String:x-units
Integer:y-position
String:y-units
String:Indexpath
Boolean:Exists
Integer:Mouse Button

Graphics Component (abstract)
Check Existence of Context Menu Entry by Textpath c

String:Textpath
String:Operator
Boolean:Exists
Integer:Mouse Button

Graphics Component (abstract)
Check Existence of Context Menu Entry by Textpath (Specify Position) c

Integer:x-position
String:x-units
Integer:y-position
String:y-units
String:Textpath
String:Operator
Boolean:Exists
Integer:Mouse Button

Graphics Component (abstract)
Check Focus c

Boolean:Has Focus

Graphics Component (abstract)
Check Property c

String:Property Name
String:Property Value
String:Operator

Graphics Component (abstract)
Check Selection of Context Menu Entry by Indexpath c

String:Indexpath
Boolean:Selected
Integer:Mouse Button

Graphics Component (abstract)
Check Selection of Context Menu Entry by Indexpath (Specify Position) c

Integer:x-position
String:x-units
Integer:y-position
String:y-units
String:Indexpath
Boolean:Selected
Integer:Mouse Button

Graphics Component (abstract)
Check Selection of Context Menu Entry by Textpath c

String:Textpath
String:Operator
Boolean:Selected
Integer:Mouse Button

Graphics Component (abstract)
Check Selection of Context Menu Entry by Textpath (Specify Position) c

Integer:x-position
String:x-units
Integer:y-position
String:y-units
String:Textpath
String:Operator
Boolean:Selected
Integer:Mouse Button

Graphics Component (abstract)
Click e

Integer:Number of Clicks
Integer:Mouse Button

Graphics Component (abstract)
Click in Component e

Integer:Number of Clicks
Integer:Mouse Button
Integer:x-position
String:x-units
Integer:y-position
String:y-units

Graphics Component (abstract)
Drag e

Integer:Mouse Button
String:Modifier Keys
Integer:x-position
String:x-units
Integer:y-position
String:y-units

Graphics Component (abstract)
Drop e

Integer:x-position
String:x-units
Integer:y-position
String:y-units
Integer:Delay before drop (milliseconds)

Graphics Component (abstract)
Select Context Menu Entry by Indexpath e

String:Indexpath
Integer:Mouse Button

Graphics Component (abstract)
Select Context Menu Entry by Indexpath (Specify Position) e

Integer:x-position
String:x-units
Integer:y-position
String:y-units
String:Indexpath
Integer:Mouse Button

Graphics Component (abstract)
Select Context Menu Entry by Textpath e

String:Textpath
String:Operator
Integer:Mouse Button

Graphics Component (abstract)
Select Context Menu Entry by Textpath (Specify Position) e

Integer:x-position
String:x-units
Integer:y-position
String:y-units
String:Menupath
String:Operator
Integer:Mouse Button

Graphics Component (abstract)
Show Text e

String:Text
Integer:Text Size (in points)
Integer:Time per Word (in milliseconds)
Integer:Window Width (in pixels)

Graphics Component (abstract)
Wait for Component e

Integer:Timeout in ms
Integer:Delay after Visibility

Graphics Component (abstract)


Check Existence of Node by Indexpath (Tree)

Parameters
Name Data Type Values Default
Path Type String absolute
relative
absolute

Name Data Type Values Default
Pre-ascend Integer - 0

\includegraphics[height=2cm]{lightbulb} The Pre-ascend parameter is simply ignored for absolute paths.

Name Data Type Values Default
Indexpath String - none

Enter the indexpath to the item you want to check. Make sure you give the whole path (either starting from the top of the tree, or at the position defined by the pre-ascend and path type parameters).

Name Data Type Values Default
Exists Boolean true
false
true


Check Existence of Node by Textpath (Tree)

Parameters
Name Data Type Values Default
Path Type String absolute
relative
absolute

Name Data Type Values Default
Pre-ascend Integer - 0

\includegraphics[height=2cm]{lightbulb} The Pre-ascend parameter is simply ignored for absolute paths.

Name Data Type Values Default
Textpath String - none

Enter the textpath to the node you want to check. Make sure you give the whole path (either starting from the top of the tree, or at the position defined by the pre-ascend and path type parameters).

Name Data Type Values Default
Operator String equals
not equals
matches
simple match
equals

\includegraphics[height=2cm]{lightbulb} When you use a regular expression for a textpath, bear in mind that each subpath is considered separately. The first path which corresponds to each subpath will be chosen. It is therefore advisable to make your regular expressions as unambiguous as possible.

Name Data Type Values Default
Exists Boolean true
false
true


Check Text (Mouse Position) (Tree)

Parameters
Name Data Type Values Default
Text String - none

Name Data Type Values Default
Operator String equals
not equals
matches
simple match
equals


Check Text of Selected Node(s) (Tree)

Parameters
Name Data Type Values Default
Text String - none

Name Data Type Values Default
Operator String equals
not equals
matches
simple match
equals


Collapse Node by Indexpath (Tree)

Parameters
Name Data Type Values Default
Path Type String absolute
relative
absolute

Name Data Type Values Default
Pre-ascend Integer - 0

\includegraphics[height=2cm]{lightbulb} The Pre-ascend parameter is simply ignored for absolute paths.

Name Data Type Values Default
Indexpath String - none

Use this parameter to specify the indexpath of the subtree you want to collapse. Make sure you give the whole path (either starting from the top of the tree, or at the position defined by the pre-ascend and path type parameters).

Example:


Collapse Node by Textpath (Tree)

Parameters
Name Data Type Values Default
Path Type String absolute
relative
absolute

Name Data Type Values Default
Pre-ascend Integer - 0

\includegraphics[height=2cm]{lightbulb} The Pre-ascend parameter is simply ignored for absolute paths.

Name Data Type Values Default
Textpath String - none

Use this parameter to specify the textpath of the subtree you want to collapse. Make sure you give the whole path (either starting from the top of the tree, or at the position defined by the pre-ascend and path type parameters).

Example:

Name Data Type Values Default
Operator String equals
not equals
matches
simple match
equals

\includegraphics[height=2cm]{lightbulb} When you use a regular expression for a treepath, bear in mind that each subpath is considered separately. The first path in the tree which corresponds to each subpath will be chosen. It is therefore advisable to make your regular expressions as unambiguous as possible.


Drag Node by Indexpath (Tree)

Parameters
Name Data Type Values Default
Mouse Button Integer 1
2
3
1

Name Data Type Values Default
Modifier Keys String none
shift
control
alt
meta
cmd
mod
none

Name Data Type Values Default
Path Type String absolute
relative
absolute

Name Data Type Values Default
Pre-ascend Integer - 0

\includegraphics[height=2cm]{lightbulb} The Pre-ascend parameter is simply ignored for absolute paths.

Name Data Type Values Default
Tree Indexpath String - none

Make sure you give the whole path (either starting from the top of the tree, or at the position defined by the pre-ascend and path type parameters).


Drag Node by Textpath (Tree)

Parameters
Name Data Type Values Default
Mouse Button Integer 1
2
3
1

Name Data Type Values Default
Modifier Keys String none
shift
control
alt
meta
cmd
mod
none

Name Data Type Values Default
Path Type String absolute
relative
absolute

Name Data Type Values Default
Pre-ascend Integer - 0

\includegraphics[height=2cm]{lightbulb} The Pre-ascend parameter is simply ignored for absolute paths.

Name Data Type Values Default
Tree Textpath String - none

Use this parameter to specify the textpath. Make sure you give the whole path (either starting from the top of the tree, or at the position defined by the pre-ascend and path type parameters).

Name Data Type Values Default
Operator String equals
not equals
matches
simple match
equals


Drop on Node by Indexpath (Tree)

Parameters
Name Data Type Values Default
Path Type String absolute
relative
absolute

Name Data Type Values Default
Pre-ascend Integer - 0

\includegraphics[height=2cm]{lightbulb} The Pre-ascend parameter is simply ignored for absolute paths.

Name Data Type Values Default
Tree Indexpath String - none

Make sure you give the whole path (either starting from the top of the tree, or at the position defined by the pre-ascend and path type parameters).

Name Data Type Values Default
Delay before drop (milliseconds) Integer - 100


Drop on Node by Textpath (Tree)

Parameters
Name Data Type Values Default
Path Type String absolute
relative
absolute

Name Data Type Values Default
Pre-ascend Integer - 0

\includegraphics[height=2cm]{lightbulb} The Pre-ascend parameter is simply ignored for absolute paths.

Name Data Type Values Default
Tree Textpath String - none

Use this parameter to specify the textpath. Make sure you give the whole path (either starting from the top of the tree, or at the position defined by the pre-ascend and path type parameters).

Name Data Type Values Default
Operator String equals
not equals
matches
simple match
equals

Name Data Type Values Default
Delay before drop (milliseconds) Integer - 100


Expand Node by Indexpath (Tree)

Parameters
Name Data Type Values Default
Path Type String absolute
relative
absolute

Name Data Type Values Default
Pre-ascend Integer - 0

\includegraphics[height=2cm]{lightbulb} The Pre-ascend parameter is simply ignored for absolute paths.

Name Data Type Values Default
Indexpath String - none

Use this parameter to specify the indexpath of the subtree you want to expand. Make sure you give the whole path (either starting from the top of the tree, or at the position defined by the pre-ascend and path type parameters).

Example:


Expand Node by Textpath (Tree)

Parameters
Name Data Type Values Default
Path Type String absolute
relative
absolute

Name Data Type Values Default
Pre-ascend Integer - 0

\includegraphics[height=2cm]{lightbulb} The Pre-ascend parameter is simply ignored for absolute paths.

Name Data Type Values Default
Textpath String - none

Use this parameter to specify the textpath of the subtree you want to expand. Make sure you give the whole path (either starting from the top of the tree, or at the position defined by the pre-ascend and path type parameters).

Example:

Name Data Type Values Default
Operator String equals
not equals
matches
simple match
equals

\includegraphics[height=2cm]{lightbulb} When you use a regular expression for a treepath, bear in mind that each subpath is considered separately. The first path in the tree which corresponds to each subpath will be chosen. It is therefore advisable to make your regular expressions as unambiguous as possible.


Move (Tree)

Parameters
Name Data Type Values Default
Direction String up
down
next
previous
up

Name Data Type Values Default
Number of Nodes Integer - 1

Name Data Type Values Default
Number of Clicks Integer - 1


Select Node by Indexpath (Tree)

Parameters
Name Data Type Values Default
Path Type String absolute
relative
absolute

Name Data Type Values Default
Pre-ascend Integer - 0

\includegraphics[height=2cm]{lightbulb} The Pre-ascend parameter is simply ignored for absolute paths.

Name Data Type Values Default
Indexpath String - none

Use this parameter to specify the node you want to select. Make sure you give the whole path (either starting from the top of the tree, or at the position defined by the pre-ascend and path type parameters).

Name Data Type Values Default
Number of Clicks Integer - 1

Name Data Type Values Default
Mouse Button Integer 1
2
3
1

Name Data Type Values Default
Extend Selection String yes
no
no


Select Node by Textpath (Tree)

Parameters
Name Data Type Values Default
Path Type String absolute
relative
absolute

Name Data Type Values Default
Pre-ascend Integer - 0

\includegraphics[height=2cm]{lightbulb} The Pre-ascend parameter is simply ignored for absolute paths.

Name Data Type Values Default
Textpath String - none

Use this parameter to specify the node you want to select. Make sure you give the whole path (either starting from the top of the tree, or at the position defined by the pre-ascend and path type parameters).

Name Data Type Values Default
Operator String equals
not equals
matches
simple match
equals

\includegraphics[height=2cm]{lightbulb} When you use a regular expression for a treepath, bear in mind that each subpath is considered separately. The first path in the tree which corresponds to each subpath will be chosen. It is therefore advisable to make your regular expressions as unambiguous as possible.
Name Data Type Values Default
Number of Clicks Integer - 1

Name Data Type Values Default
Mouse Button Integer 1
2
3
1

Name Data Type Values Default
Extend Selection String yes
no
no


Store Text at Mouse Position (Tree)

Parameters
Name Data Type Values Default
Variable Name Variable - none


Store Text of Selected Node (Tree)

Parameters
Name Data Type Values Default
Variable Name Variable - none

(SWT) Tree (swt)
Tree Table (swt)



Copyright BREDEX GmbH 2011. Made available under the Eclipse Public License v1.0.