Libraries.Interface.Selections.TreeSelection Documentation
A selection represents what would be interacted with if the parent is used. The general idea of selection is common across user interface elements. For example, trees have a selection, which represents the item in the tree that the user is interacting with if the tree itself has a focus. Similarly, text boxes have a very different kind of selection, which represents which region of the text is being interacted with. Selection represents a generic way to get the name of the selection. In the case of TreeSelection, this returns a path of TreeItem objects, which can be traversed to learn the specific and unique path to the current tree selection. This path should be interpreted from high level to low level. For example, if we were selected on Game -> Player 1, then the TreeItem objects in the path would be Game first and Player 1 second.
Inherits from: Libraries.Interface.Selections.Selection, Libraries.Language.Object
Summary
Actions Summary Table
Actions | Description |
---|---|
Compare(Libraries.Language.Object object) | This action compares two object hash codes and returns an integer. |
Empty() | This action empties the selection path. |
Equals(Libraries.Language.Object object) | This action determines if two objects are equal based on their hash code values. |
GetDisplayName() | This action gets the name that would be shown to the user. |
GetHashCode() | This action gets the hash code for an object. |
GetItem() | This action returns the item that contains the selection. |
GetPath() | This action gets the Path of the selection. |
GetTreeItem() | This action returns the selected TreeItem. |
Initialize(Libraries.Interface.Item item) | This action is used internally to set the selection owner. |
Initialize(Libraries.Interface.Item item, text displayName) | This action sets up the component with default attributes. |
IsEmpty() | This action returns true if there is no selection. |
NotifySelectionListeners() | This action sends information that the selection was changed to all listeners. |
Set(Libraries.Containers.Array<Libraries.Interface.Controls.TreeItem> items) | This action is used internally to set the path on the Selection. |
SetDisplayName(text name) | This action sets the name that would be shown to the user. |
Actions Documentation
Compare(Libraries.Language.Object object)
This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.
Example Code
Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)
Parameters
- Libraries.Language.Object: The object to compare to.
Return
integer: The Compare result, Smaller, Equal, or Larger.
Empty()
This action empties the selection path.
Equals(Libraries.Language.Object object)
This action determines if two objects are equal based on their hash code values.
Example Code
use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)
Parameters
- Libraries.Language.Object: The to be compared.
Return
boolean: True if the hash codes are equal and false if they are not equal.
GetDisplayName()
This action gets the name that would be shown to the user.
Example Code
action SelectionChanged(Selection selection)
output selection:GetDisplayName()
end
Return
text: The display name to be given to the user.
GetHashCode()
This action gets the hash code for an object.
Example Code
Object o
integer hash = o:GetHashCode()
Return
integer: The integer hash code of the object.
GetItem()
This action returns the item that contains the selection. It is not the selection itself.
Example Code
action SelectionChanged(Selection selection)
Item theParentItem = selection:GetItem()
end
Return
GetPath()
This action gets the Path of the selection. This path should be interpreted from high level to low level. For example, if we were selected on Game -> Player 1, then the TreeItem objects in the path would be Game first and Player 1 second.
Return
Libraries.Containers.Array: The items in the selection.
GetTreeItem()
This action returns the selected TreeItem. This is the last TreeItem in the path. If the selection is empty, this will return undefined.
Return
Libraries.Interface.Controls.TreeItem: The selected TreeItem, or undefined if the selection is empty.
Initialize(Libraries.Interface.Item item)
This action is used internally to set the selection owner.
Parameters
Initialize(Libraries.Interface.Item item, text displayName)
This action sets up the component with default attributes.
Parameters
- Libraries.Interface.Item: The parent item in the selection.
- text displayName: The name of the selected item.
IsEmpty()
This action returns true if there is no selection.
Return
boolean: True if there is no selection.
NotifySelectionListeners()
This action sends information that the selection was changed to all listeners.
Set(Libraries.Containers.Array<Libraries.Interface.Controls.TreeItem> items)
This action is used internally to set the path on the Selection.
Parameters
SetDisplayName(text name)
This action sets the name that would be shown to the user. It also changes the selection, triggering a SelectionEvent.
Example Code
action SelectionChanged(Selection selection)
selection:SetDisplayName("A new name I want to change to")
end
Parameters
- text name: The name to display.