onAction([callback], [remove])
Class: SplitView. Method inherited from UIComponent.
Description:
Gets, registers or unregisters a handler function for component's primary action event.
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
|
|
function |
The event handler function that receives a ActionEvent object. Pass |
|
|
|
boolean |
false |
Set to |
Returns:
An array of handler functions if no arguments are passed, otherwise this component for method chaining.
Type: this | Array.<function()>
Examples:
// Example event object:
const e = {
target: object, // The component that triggered the event.
command: string, // Button text or a specified command using .command("") method
modifiers: number, // Keyboard modifiers (bitmask or flags).
alt: boolean, // Indicates if ALT key was pressed.
shift: boolean, // Indicates if SHIFT key was pressed.
ctrl: boolean, // Indicates if CTRL key was pressed.
type: string, // `action` or `index_change`. Present when applicable.
x: number, // Mouse x position relative to component
y: number, // Mouse y position relative to component
screenX: number, // Mouse x position relative to default screen
screenY: number, // Mouse y position relative to default screen
interactive: boolean, // Indicates if the action was triggered by user's interaction (not programmatically). Present when applicable.
selected: false // Present when applicable.
};
