Tool

Base class for tools.

May be configured with a cls and a handler which is a function (or name of a function) in the owning Panel.

This widget is not intended to be used directly

No results

Configs

Configs are options you supply in a configuration object when creating an instance of this class

handler : Function/String
The function to call when this tool is clicked. May be a function or function name prepended by "up." that is resolvable in an ancestor component (such as an owning Grid, Scheduler, Calendar, Gantt or TaskBoard)
Parameters
- event : Event
  
  The DOM event which activated the tool
- panel : Panel
  
  The owning Panel of the tool
- tool : Tool
  
  The clicked Tool
Returns

void
href : String

If provided, turns the tool into a link
repeat : ClickRepeaterConfig

A ClickRepeater config object to specify how click-and-hold gestures repeat the click action.
align : 'start'/'end''end'

Specify 'start' to place the tool before the owner's central element (e.g., the title of the panel).

Properties are getters/setters or publicly accessible variables on this class

Events are triggered for certain actions in this class and can be listened for to react to those actions in your code

Event handlers are callbacks called as a result of certain actions in this class

type: tool

Core/widget/Tool.js