Libraries.Interface.Selections.TreeTableSelection Documentation

Inherits from: Libraries.Interface.Selections.Selection, Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
Empty()The Empty action sets the selection to be empty, or in other words, there is no cell actively selected.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
Get()
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.
GetTreeTable()
GetX()
GetY()
Initialize(Libraries.Interface.Item item)
Initialize(Libraries.Interface.Item item, text displayName)This action sets up the component with default attributes.
IsEmpty()
NotifySelectionListeners()This action sends information that the selection was changed to all listeners.
Set(integer x, integer y)This action selects a single cell in the TreeTable.
Set(Libraries.Interface.Controls.TreeTableCell cell)This action selects a single cell in the TreeTable.
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

Return

integer: The Compare result, Smaller, Equal, or Larger.

Empty()

The Empty action sets the selection to be empty, or in other words, there is no cell actively selected. When the selection is empty, the x and y coordinates will be -1.

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

Return

boolean: True if the hash codes are equal and false if they are not equal.

Get()

Return

Libraries.Interface.Controls.TreeTableCell

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

Libraries.Interface.Item:

GetTreeTable()

Return

Libraries.Interface.Controls.TreeTable

GetX()

Return

integer

GetY()

Return

integer

Initialize(Libraries.Interface.Item item)

Parameters

Initialize(Libraries.Interface.Item item, text displayName)

This action sets up the component with default attributes.

Parameters

IsEmpty()

Return

boolean

NotifySelectionListeners()

This action sends information that the selection was changed to all listeners.

Set(integer x, integer y)

This action selects a single cell in the TreeTable. In this case, the x represents the column number and the y represents the row.

Parameters

Set(Libraries.Interface.Controls.TreeTableCell cell)

This action selects a single cell in the TreeTable.

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