Documentation
Main | Download | Documentation | FAQ | Forums | Boxely Buzz
User Guide | OCP Services APIs | Actions | Animation | Event Types | Styles


Toolkit Actions Reference

About Toolkit Actions

This is a reference of built-in actions that are provided by Boxely.

Action commands have a prefix of "toolkit:" and are associated with a reaction element as seen in the sample code below:

<behavior id="myBox">
  <reaction event="click" action="toolkit:Close"/>
</behavior>

General

Focus

Focuses the target box.

Blur

Removes focus from the target box and leaves the scene without a focused box.

ScrollUp

Scrolls the target box up by a single increment.

ScrollDown

Scrolls the target box down by a single increment.

MouseWheelScrollUp

Scrolls the target box up based on mouse wheel roll.

MouseWheelScrollDown

Scrolls the target box down based on mouse wheel roll.

Pop

Opens a popup menu.

PopChained

Opens a menu.

CloseSiblingPopup

Closes the popup of the sibling of the target box, if applicable.

Shut

Closes the popup menu.

Close

Closes the scene containing the target box. For example, when called on a button control it will simulate pressing the button.

Control Actions

Command

Invokes the command associated with the control.

Toggle

Toggles the state of the control in controls like check boxes which have two control states.

Range Actions

SetMax

Sets the range target box's value to the maximum possible.

SetMin

Sets the range target box's value to the minimum possible.

NudgeUp

On a range target box, increases its value by 1 and moves the slider up or right, depending on the orientation.

NudgeDown

On a range target box, decreases its value by 1 and moves the slider down or left, depending on the orientation.

NudgePageUp

On a range target box, increases its value by a page and moves the slider up or right, depending on the orientation.

NudgePageDown

On a range target box, decreases its value by a page and moves the slider down or left, depending on the orientation.

Select Actions

ExpandRow

Expands the selected row in controls which have expandable and contractible rows.

ContractRow

Contracts the selected row in controls which have expandable and contractible rows.

ToggleRow

Toggles the expanded/contracted state of the selected row in controls which have expandable and contractible rows.

CursorUp

Moves the cursor up one row. Selection is not modified.

CursorDown

Moves the cursor down one row. Selection is not modified.

CursorPageUp

Moves the cursor up one page. Selection is not modified.

CursorPageDown

Moves the cursor down one page. Selection is not modified.

CursorSelect

Selects the cursor row, if not already selected.

ToggleSelect

Inverses the current selection.

SelectUp

Moves the selection up one row.

SelectDown

Moves the selection down one row.

SelectUpExtend

Adds the row above the currently selected row to the list of selected rows.

SelectDownExtend

Adds the row below the currently selected row to the list of selected rows.

SelectPageUp

Moves the selection up one page.

SelectPageDown

Moves the selection down one page.

SelectPageUpExtend

Extends the selection to include all rows between the currently selected row and the row one page above it.

SelectPageDownExtend

Extends the selection to include all rows between the currently selected row and the row one page below it.

SelectHome

Moves the selection to the first row.

SelectEnd

Moves the selection to the last row.

SelectHomeExtend

Moves the selection to the first row and selects all rows between the first row and the currently selected row.

SelectEndExtend

Moves the selection to the last row and selects all rows between the last row and the currently selected row.

SelectAll

Selects all rows.

Text Actions

AcceptDialog

Invokes the OK (affirmative) button in a dialog.

CancelDialog

Invokes the Cancel (negative) button in a dialog.

StopEventPropagation

Prevents the event from propagating to parent boxes.

EnableEventPropagation

Allows the event to propagate to parent boxes, if prevented otherwise.

InvalidInput

Causes the target box to display that an invalid input was provided.

UndoText

Undoes the last action in a text input.

CutText

Cuts the text in the specified text control.

PasteText

Pastes the text from previous cut.

DeleteText

Deletes the text in the specified text control.

SelectAllText

Selects all text in the specified text control.

Copyright © 2007 AOL, LLC. All rights reserved.