Libraries.Interface.Selections.TextFieldSelection 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 TextFieldSelection, this selection is very different from the Tree or Menu Selections. Instead, this selection allows us to obtain information about the location of the Caret or, If multiple characters are selected, the begin and end of the selection region.

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()This action empties the selection.
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.
GetEndIndex()This action obtains the ending index of the selection.
GetHashCode()This action gets the hash code for an object.
GetItem()This action returns the item that contains the selection.
GetStartIndex()This action obtains the starting index of the selection.
GetText()
GetTextField()This action is a helper to obtain the TextField without casting.
Initialize(Libraries.Interface.Item item, text displayName)This action sets up the component with default attributes.
IsCaretAtEnd()This action returns true if the caret is at the end of the text value.
IsEmpty()This action returns true if there is no selection.
IsTextChanging()This action returns true if the current selection was the result of insertion or deletion into the TextBox, or false if the selection moved without changing the text.
NotifySelectionListeners()This action sends information that the selection was changed to all listeners.
Set(integer startIndex, integer endIndex, boolean caretAtEnd, boolean textChanged)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

Return

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

Empty()

This action empties the selection.

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.

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.

GetEndIndex()

This action obtains the ending index of the selection.

Return

integer: The index

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:

GetStartIndex()

This action obtains the starting index of the selection.

Return

integer: The index

GetText()

Return

text

GetTextField()

This action is a helper to obtain the TextField without casting.

Return

Libraries.Interface.Controls.TextField: The TextField associated with this selection.

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

This action sets up the component with default attributes.

Parameters

IsCaretAtEnd()

This action returns true if the caret is at the end of the text value.

Return

boolean: Whether the caret is at the end.

IsEmpty()

This action returns true if there is no selection. In the case of the textbox, there is considered to be no selection if the indices are the same.

Return

boolean: True if there is no selection.

IsTextChanging()

This action returns true if the current selection was the result of insertion or deletion into the TextBox, or false if the selection moved without changing the text.

Return

boolean: Whether this selection was the result of TextBox insertion or deletion.

NotifySelectionListeners()

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

Set(integer startIndex, integer endIndex, boolean caretAtEnd, boolean textChanged)

This action is used internally to set the path on the Selection. It should generally not needed by a programmer not working in Quorum's standard library.

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