Input mode that can be used to interactively edit a table.
Remarks
This mode can either be used as a standalone input mode, or as a child mode of GraphEditorInputMode. In the latter case, some child modes of this implementation are disabled:
In addition, the stripeSelection is optionally synchronized with the graphSelection.
Note that if the TableEditorInputMode is used without a GraphEditorInputMode, labels can only be edited interactively if a EditLabelInputMode is added.
Type Details
- yFiles module
- view
See Also
Constructors
Creates a new instance.
Parameters
A map of options to pass to the method.
- resizeStripeInputMode - ResizeStripeInputMode
- The ResizeStripeInputMode that is used to change the size of a stripe interactively. This option either sets the value directly or recursively sets properties to the instance of the resizeStripeInputMode property on the created object.
- reparentStripeHandler - IReparentStripeHandler
- The reparentStripeHandler property. This option sets the reparentStripeHandler property on the created object.
- reparentStripeInputMode - ReparentStripeInputMode
- The ReparentStripeInputMode that is used to change a stripe's position in the table hierarchy. This option sets the reparentStripeInputMode property on the created object.
- stripeDropInputMode - StripeDropInputMode
- The stripeDropInputMode property that is responsible for handling drag and drop operations of stripes onto the Canvas. This option either sets the value directly or recursively sets properties to the instance of the stripeDropInputMode property on the created object.
- keyboardInputMode - KeyboardInputMode
- The keyboardInputMode. This option either sets the value directly or recursively sets properties to the instance of the keyboardInputMode property on the created object.
- installCommandPredicate - function(Command):boolean
- A predicate that is queried by onKeyboardInputModeChanged to determine whether a built-in Command should be installed. This option sets the installCommandPredicate property on the created object.
Signature Details
function(obj: Command) : booleanRepresents the method that defines a set of criteria and determines whether the specified object meets those criteria.Parameters
- obj - Command
- The object to compare against the criteria defined within the method represented by this delegate.
Returns
- boolean
trueif obj meets the criteria defined within the method represented by this delegate; otherwise,false.
- labelEditableItems - StripeTypes
- A property that determines which types of items may have their labels edited. This option sets the labelEditableItems property on the created object.
- addLabelPredicate - function(IModelItem):boolean
- A predicate that is queried to determine whether a label can be added to the given IModelItem. This option sets the addLabelPredicate property on the created object.
Signature Details
function(obj: IModelItem) : booleanRepresents the method that defines a set of criteria and determines whether the specified object meets those criteria.Parameters
- obj - IModelItem
- The object to compare against the criteria defined within the method represented by this delegate.
Returns
- boolean
trueif obj meets the criteria defined within the method represented by this delegate; otherwise,false.
- editLabelPredicate - function(IModelItem):boolean
- A predicate that is queried to determine whether the given label or a label owned by the given owner can be edited. This option sets the editLabelPredicate property on the created object.
Signature Details
function(obj: IModelItem) : booleanRepresents the method that defines a set of criteria and determines whether the specified object meets those criteria.Parameters
- obj - IModelItem
- The object to compare against the criteria defined within the method represented by this delegate.
Returns
- boolean
trueif obj meets the criteria defined within the method represented by this delegate; otherwise,false.
- clickInputMode - ClickInputMode
- The clickInputMode. This option either sets the value directly or recursively sets properties to the instance of the clickInputMode property on the created object.
- clickablePredicate - function(TableHitTestResult):boolean
- A predicate that is queried to determine whether the item described by the TableHitTestResult can be clicked. This option sets the clickablePredicate property on the created object.
Signature Details
function(obj: TableHitTestResult) : booleanRepresents the method that defines a set of criteria and determines whether the specified object meets those criteria.Parameters
- obj - TableHitTestResult
- The object to compare against the criteria defined within the method represented by this delegate.
Returns
- boolean
trueif obj meets the criteria defined within the method represented by this delegate; otherwise,false.
- doubleClickablePredicate - function(TableHitTestResult):boolean
- A predicate that is queried to determine whether the item described by the TableHitTestResult can be double-clicked. This option sets the doubleClickablePredicate property on the created object.
Signature Details
function(obj: TableHitTestResult) : booleanRepresents the method that defines a set of criteria and determines whether the specified object meets those criteria.Parameters
- obj - TableHitTestResult
- The object to compare against the criteria defined within the method represented by this delegate.
Returns
- boolean
trueif obj meets the criteria defined within the method represented by this delegate; otherwise,false.
- deletableItems - StripeTypes
- A property that determines which types of items may be deleted using the deleteSelection action. This option sets the deletableItems property on the created object.
- deletablePredicate - function(IStripe):boolean
- A predicate that is queried to determine whether a stripe should be deleted during deleteSelection. This option sets the deletablePredicate property on the created object.
Signature Details
function(obj: IStripe) : booleanRepresents the method that defines a set of criteria and determines whether the specified object meets those criteria.Parameters
- obj - IStripe
- The object to compare against the criteria defined within the method represented by this delegate.
Returns
- boolean
trueif obj meets the criteria defined within the method represented by this delegate; otherwise,false.
- selectableItems - StripeTypes
- A property that determines which types of items should be selectable at all. This option sets the selectableItems property on the created object.
- clickSelectableItems - StripeTypes
- A property that determines which types of items should be selectable through mouse clicks. This option sets the clickSelectableItems property on the created object.
- allowEditLabel - boolean
- Whether the label editor will be automatically invoked if the F2 key is pressed. This option sets the allowEditLabel property on the created object.
- allowAddLabel - boolean
- Whether the label editor will be automatically invoked if the Shift+F2 key is pressed. This option sets the allowAddLabel property on the created object.
- multiSelectionRecognizer - function(EventArgs, unknown):boolean
- The event recognizer that determines whether a click is deemed a multi-selection gesture. This option sets the multiSelectionRecognizer property on the created object.
Signature Details
function(evt: EventArgs, eventSource: unknown) : booleanA callback that recognizes events.Given a sender and an event argument, delegates decide whether the event is treated as a match depending on the context.Parameters
- evt - EventArgs
- The arguments of the event to be decided to handle.
- eventSource - unknown
- The source of the event.
Returns
- boolean
trueif theevtis considered to be handled.
- clickSelectableRegions - StripeSubregionTypes
- Clicks on which StripeSubregionTypes(s) should toggle a stripe selection state. This option sets the clickSelectableRegions property on the created object.
- clickableItems - StripeTypes
- A property that determines for which types of items should mouse clicks be handled by this mode. This option sets the clickableItems property on the created object.
- clickableRegions - StripeSubregionTypes
- Clicks on which StripeSubregionTypes(s) react to mouse clicks. This option sets the clickableRegions property on the created object.
- synchronizeWithGraphSelection - boolean
- A value indicating whether stripeSelection should be synchronized with the graphSelection if this instance is installed as a child of a GraphEditorInputMode instance. This option sets the synchronizeWithGraphSelection property on the created object.
- allowMixedSelection - boolean
- Whether to allow mixed selections of graph elements and table elements This option sets the allowMixedSelection property on the created object.
- allowEditLabelOnDoubleClick - boolean
- A value determining whether double-clicking should start label editing. This option sets the allowEditLabelOnDoubleClick property on the created object.
- exclusive - boolean
- A value indicating whether this mode will be the only one running when it has the mutex. This option sets the exclusive property on the created object.
- enabled - boolean
- The enabled state of this input mode. This option sets the enabled property on the created object.
- priority - number
- defaultCursor - Cursor
- The cursor to use whenever no child mode prefers a different cursor. This option sets the defaultCursor property on the created object.
Properties
Gets or sets a predicate that is queried to determine whether a label can be added to the given IModelItem.
Remarks
Signature Details
function(obj: IModelItem) : boolean
Parameters
- obj - IModelItem
- The object to compare against the criteria defined within the method represented by this delegate.
Returns
- boolean
trueif obj meets the criteria defined within the method represented by this delegate; otherwise,false.
Gets or sets whether the label editor will be automatically invoked if the Shift+F2 key is pressed.
Remarks
true. If label adding is allowed, pressing Shift+F2 will start the label editor. By default, this feature is enabled.See Also
Gets or sets whether the label editor will be automatically invoked if the F2 key is pressed.
Remarks
true. If label editing is allowed, pressing F2 will start the label editor. By default, this feature is enabled.See Also
Gets or sets a value determining whether double-clicking should start label editing.
Remarks
If enabled, double-clicking an item will automatically execute the EDIT_LABEL command.
This setting has no effect if label editing is generally disallowed by setting allowEditLabel to false.
If the TableEditorInputMode instance is installed as child mode of a GraphEditorInputMode instance, editing a label by double clicks is only allowed if both the value of this property and the value of allowEditLabelOnDoubleClick are true.
The default value is true.
See Also
Gets or sets whether to allow mixed selections of graph elements and table elements
Remarks
true. Changing this property only has an effect if synchronizeWithGraphSelection is enabled.Gets or sets a property that determines for which types of items should mouse clicks be handled by this mode.
Gets or sets a predicate that is queried to determine whether the item described by the TableHitTestResult can be clicked.
Remarks
Signature Details
function(obj: TableHitTestResult) : boolean
Parameters
- obj - TableHitTestResult
- The object to compare against the criteria defined within the method represented by this delegate.
Returns
- boolean
trueif obj meets the criteria defined within the method represented by this delegate; otherwise,false.
Gets or sets clicks on which StripeSubregionTypes(s) react to mouse clicks.
Gets or sets the clickInputMode.
Remarks
If the field has not yet been initialized upon first access, a new instance will be assigned. Upon change the onClickInputModeChanged method will be called. If the parent TableEditorInputMode instance is installed as child mode of a GraphEditorInputMode instance, this mode is not used, since all work is delegated to the parent's clickInputMode instance. This implies that all modifications made to the property value have no effect as long as the parent mode is child of a GraphEditorInputMode instance.
By default this input mode has a priority of 0.
Property Value
Gets or sets a property that determines which types of items should be selectable through mouse clicks.
Gets or sets clicks on which StripeSubregionTypes(s) should toggle a stripe selection state.
Remarks
See Also
Gets the installed controller.
Defined in
Gets or sets the cursor to use whenever no child mode prefers a different cursor.
Remarks
nullSee Also
Defined in
Gets or sets a property that determines which types of items may be deleted using the deleteSelection action.
Gets or sets a predicate that is queried to determine whether a stripe should be deleted during deleteSelection.
Remarks
Signature Details
function(obj: IStripe) : boolean
Parameters
- obj - IStripe
- The object to compare against the criteria defined within the method represented by this delegate.
Returns
- boolean
trueif obj meets the criteria defined within the method represented by this delegate; otherwise,false.
Gets or sets a predicate that is queried to determine whether the item described by the TableHitTestResult can be double-clicked.
Remarks
Signature Details
function(obj: TableHitTestResult) : boolean
Parameters
- obj - TableHitTestResult
- The object to compare against the criteria defined within the method represented by this delegate.
Returns
- boolean
trueif obj meets the criteria defined within the method represented by this delegate; otherwise,false.
Gets or sets a predicate that is queried to determine whether the given label or a label owned by the given owner can be edited.
Remarks
Signature Details
function(obj: IModelItem) : boolean
Parameters
- obj - IModelItem
- The object to compare against the criteria defined within the method represented by this delegate.
Returns
- boolean
trueif obj meets the criteria defined within the method represented by this delegate; otherwise,false.
Gets or sets the enabled state of this input mode.
Remarks
Defined in
Gets or sets a value indicating whether this mode will be the only one running when it has the mutex.
Remarks
The value of this property will be delegated to the exclusive property of the controller.
If this mode is marked as exclusive and has the mutex, all other modes added to the same MultiplexingInputMode will be deactivated. Otherwise, it will always run concurrently with all other modes.
Defined in
Gets or sets a predicate that is queried by onKeyboardInputModeChanged to determine whether a built-in Command should be installed.
Remarks
true.Signature Details
function(obj: Command) : boolean
Parameters
- obj - Command
- The object to compare against the criteria defined within the method represented by this delegate.
Returns
- boolean
trueif obj meets the criteria defined within the method represented by this delegate; otherwise,false.
See Also
Gets or sets the keyboardInputMode.
Remarks
If the field has not yet been initialized upon first access, a new instance will be assigned. Upon change the onKeyboardInputModeChanged method will be called. If the parent TableEditorInputMode instance is installed as child mode of a GraphEditorInputMode instance, this mode is not used, since all work is delegated to the parent's keyboardInputMode instance. This implies that all modifications made to the property value have no effect as long as the parent mode is child of a GraphEditorInputMode instance.
By default this input mode has a priority of 0.
Property Value
Gets or sets a property that determines which types of items may have their labels edited.
Remarks
See Also
Gets or sets the event recognizer that determines whether a click is deemed a multi-selection gesture.
Remarks
Signature Details
function(evt: EventArgs, eventSource: unknown) : boolean
Parameters
- evt - EventArgs
- The arguments of the event to be decided to handle.
- eventSource - unknown
- The source of the event.
Returns
- boolean
trueif theevtis considered to be handled.
Gets the IInputMode that currently owns the mutex.
Retrieves the IInputModeContext this mode has been installed in.
Remarks
null if this mode is currently not installed. Use createInputModeContext to obtain a context that has this IInputMode as the inputMode.Defined in
Gets the priority of this input mode.
Remarks
See Also
Implements
Gets or sets the reparentStripeHandler property.
Remarks
See Also
Gets or sets the ReparentStripeInputMode that is used to change a stripe's position in the table hierarchy.
Remarks
0. If the field has not yet been initialized upon first access, a new instance will be assigned. Upon change the onReparentStripeInputModeChanged method will be called.Gets or sets the ResizeStripeInputMode that is used to change the size of a stripe interactively.
Remarks
0. If the field has not yet been initialized upon first access, a new instance will be assigned. Upon change the onResizeStripeInputModeChanged method will be called.Gets or sets a property that determines which types of items should be selectable at all.
Gets or sets the stripeDropInputMode property that is responsible for handling drag and drop operations of stripes onto the Canvas.
Remarks
The mode by default is disabled and needs to be enabled to work, first. If the field has not yet been initialized upon first access, a new instance will be assigned. Upon change, onStripeDropInputModeChanged will be called.
By default, this input mode has a priority of 70.
Gets the selected stripes
Gets or sets a value indicating whether stripeSelection should be synchronized with the graphSelection if this instance is installed as a child of a GraphEditorInputMode instance.
Remarks
This feature needs to be disabled temporarily if the selection is changed.
By default, this feature is enabled.
Methods
Adds the given mode.
Remarks
The input modes will be ordered according to their priority: Input modes with lower priority will be installed earlier.
Input modes will run exclusively if the exclusive property of their installed controller is set to true. Otherwise they cannot and will not be deactivated if another IInputMode acquires the mutex.
Parameters
A map of options to pass to the method.
- mode - IInputMode
- The input mode to add to this mode.
Throws
- Exception({ name: 'ArgumentError' })
- If the same
modeis already added to this instance.
Examples
const multiplexingInputMode = new MultiplexingInputMode()
const waitInputMode = new WaitInputMode()
waitInputMode.priority = 0
multiplexingInputMode.add(waitInputMode)
const moveInputMode = new MoveViewportInputMode()
moveInputMode.priority = 5
multiplexingInputMode.add(moveInputMode)
graphComponent.inputMode = multiplexingInputModeconst mode = new GraphEditorInputMode()
const customInputMode = new CustomInputMode()
customInputMode.priority = 10
mode.add(customInputMode)Defined in
Adjusts the cursor of the CanvasComponent according to the current input mutex owner or the first mode in the list whose ConcurrencyController returns a non-null preferredCursor.
Remarks
Defined in
Cancels all modes.
Implements
Called by the child context's lookup method.
Parameters
A map of options to pass to the method.
- type - Constructor
- The type argument passed to lookup.
Returns
- ↪any?
- The result of the lookup query, or
null.
See Also
Overrides
Clears the current selection.
Actually performs the click or tap on the given item.
Remarks
Parameters
A map of options to pass to the method.
- tableHitTestResult - TableHitTestResult
- Information about the item that has been clicked.
- evt - ClickEventArgs
- The original event arguments for the click. Setting its handled property to
truewill indicate that the click was handled. By default this happens when the clicked item is either selected or focused.
Yields an IInputModeContext for the child modes of this mode.
Remarks
Returns
- ↪IInputModeContext
- A new instance that delegates to the parent's context.
Defined in
Helper method that yields a suitably configured InputModeEventArgs for this input mode.
Parameters
A map of options to pass to the method.
- context - IInputModeContext
An input mode context that is available in the InputModeEventArgs.
Can be
nullin which case a new context for this instance is created automatically.
Returns
- ↪InputModeEventArgs
- An input mode event argument that is configured for this instance.
Defined in
Create a new instance of IStripeSelection the first time property stripeSelection is accessed.
Remarks
false.Returns
- ↪IStripeSelection
- A new IStripeSelection instance.
This method deletes the currently selected stripes.
Remarks
See Also
Actually performs a double click on the given item.
Remarks
trueParameters
A map of options to pass to the method.
- tableHitTestResult - TableHitTestResult
- The item that has been double-clicked.
- evt - ClickEventArgs
- The original event arguments for the click. Setting its handled property to
truewill indicate that the double click was handled and events on other items in the same location are no longer raised.
Starts label editing by executing EDIT_LABEL.
Remarks
Parameters
A map of options to pass to the method.
- item - IModelItem
- The item whose label or the label itself that should be edited upon the double click gesture.
Returns
- ↪boolean
trueiff the request was handled.
See Also
findStripe
(location: Point, stripeTypes: StripeTypes, subregionTypes: StripeSubregionTypes, filter?: function(StripeSubregion):boolean) : StripeSubregionUsed as a callback to find the items underneath a certain point.
Parameters
A map of options to pass to the method.
- location - Point
- The location to test.
- stripeTypes - StripeTypes
- An enumeration value of StripeTypes to specify the stripe type.
- subregionTypes - StripeSubregionTypes
- An enumeration value of StripeSubregionTypes to further restrict the stripe region.
- filter - function(StripeSubregion):boolean
- Additional predicate to further restrict the hit test results.
Signature Details
function(obj: StripeSubregion) : booleanRepresents the method that defines a set of criteria and determines whether the specified object meets those criteria.Parameters
- obj - StripeSubregion
- The object to compare against the criteria defined within the method represented by this delegate.
Returns
- boolean
trueif obj meets the criteria defined within the method represented by this delegate; otherwise,false.
Returns
- ↪StripeSubregion?
- The stripe subregions that have been found for the location or
null.
findStripes
(location: Point, stripeTypes: StripeTypes, subregionTypes: StripeSubregionTypes, filter?: function(StripeSubregion):boolean) : IEnumerable<StripeSubregion>Used as a callback to find the items underneath a certain point.
Parameters
A map of options to pass to the method.
- location - Point
- The location to test.
- stripeTypes - StripeTypes
- An enumeration value of StripeTypes to specify the stripe type.
- subregionTypes - StripeSubregionTypes
- An enumeration value of StripeSubregionTypes to further restrict the stripe region.
- filter - function(StripeSubregion):boolean
- Additional predicate to further restrict the hit test results.
Signature Details
function(obj: StripeSubregion) : booleanRepresents the method that defines a set of criteria and determines whether the specified object meets those criteria.Parameters
- obj - StripeSubregion
- The object to compare against the criteria defined within the method represented by this delegate.
Returns
- boolean
trueif obj meets the criteria defined within the method represented by this delegate; otherwise,false.
Returns
- ↪IEnumerable<StripeSubregion>
- The stripe subregions that have been found for the location.
Returns a list of all modes managed by this instance sorted by their priority.
Performs one-time initialization of this instance.
Remarks
This method should not be invoked by subclasses. This will be done automatically upon first installation of this mode.
This code will be executed only once per instance. The parentInputModeContext property will be null when this code is executed. This method should not be used to install this mode into a specific canvas. Subclasses should always call base.Initialize() first.
See Also
Overrides
Inserts a new stripe as child of owner
Remarks
size and otherwise the default settings of the table where owner belongs to. If size is entered as 0, the owner's default size is used.Parameters
A map of options to pass to the method.
- owner - IStripe
- The parent of the new stripe.
- index - number
- The index where to insert the new stripe.
- size - number
- The initial size of the stripe.
Returns
Installs this mode into the given context that is provided by the canvas.
Remarks
In general a mode can only be installed into a single canvas at all times.
This method is called to initialize this instance. Implement this method to register the corresponding event handlers for the various input events this mode will listen to.
When this instance gets uninstalled from the context the same context instance will be passed to it.
Implementations may hold a reference to the context instance and use it while installed.
Parameters
A map of options to pass to the method.
- context - IInputModeContext
- The context that this instance shall be installed into. The same instance will be passed to this instance during uninstall. A reference to the context may be kept and queried while the mode is installed.
- controller - ConcurrencyController
- The ConcurrencyController for this mode.
See Also
Overrides
Invalidates the canvas this mode is currently installed in.
Defined in
Called when the clickInputMode property value changes and after initialization of the field.
Parameters
A map of options to pass to the method.
- oldMode - ClickInputMode
- the old value, which may be
nullthe first time - newMode - ClickInputMode
- the new value
Called once clickInputMode triggers the clicked event with clickCount 1 and pointerType MOUSE.
Parameters
A map of options to pass to the method.
- evt - ClickEventArgs
- The ClickEventArgs of the event.
- sender - any
- The sender of the event.
Called once clickInputMode triggers the clicked event with clickCount 2 and pointerType MOUSE.
Parameters
A map of options to pass to the method.
- evt - ClickEventArgs
- The ClickEventArgs of the event.
- sender - any
- The sender of the event.
Called after the active property of the installed ConcurrencyController has been set to true.
Remarks
Defined in
Called after the active property of the installed ConcurrencyController has been set to false.
Remarks
null and releases the mutex if the mutex is currently owned by this instance. Also, all concurrent child modes will be disabled.Defined in
Raises the deleted-item event.
Parameters
A map of options to pass to the method.
- evt - InputModeItemEventArgs<IModelItem>
- The instance containing the event data.
Raises the deleted-selection event.
Parameters
A map of options to pass to the method.
- evt - SelectionEventArgs<IStripe>
- The SelectionEventArgs<T> instance containing the event data.
Raises the deleting-selection event.
Parameters
A map of options to pass to the method.
- evt - SelectionEventArgs<IStripe>
- The SelectionEventArgs<T> instance containing the event data.
Raises the item-clicked event.
Remarks
true.Parameters
A map of options to pass to the method.
- evt - TableItemClickedEventArgs<IModelItem>
- The ItemClickedEventArgs<T> instance that contains the item that has been clicked.
Raises the item-double-clicked event.
Remarks
true.Parameters
A map of options to pass to the method.
- evt - TableItemClickedEventArgs<IModelItem>
- The TableItemClickedEventArgs<T> instance that contains the item that has been double-clicked.
Raises the item-left-clicked event.
Remarks
true.Parameters
A map of options to pass to the method.
- evt - TableItemClickedEventArgs<IModelItem>
- The TableItemClickedEventArgs<T> instance that contains the item that has been clicked.
Raises the item-left-double-clicked event.
Remarks
true.Parameters
A map of options to pass to the method.
- evt - TableItemClickedEventArgs<IModelItem>
- The TableItemClickedEventArgs<T> instance that contains the item that has been double clicked.
Raises the item-right-clicked event.
Remarks
true.Parameters
A map of options to pass to the method.
- evt - TableItemClickedEventArgs<IModelItem>
- The ItemClickedEventArgs<T> instance that contains the item that has been clicked.
Raises the item-right-double-clicked event.
Remarks
true.Parameters
A map of options to pass to the method.
- evt - TableItemClickedEventArgs<IModelItem>
- The TableItemClickedEventArgs<T> instance that contains the item that has been double clicked.
Called when the keyboardInputMode changed.
Parameters
A map of options to pass to the method.
- oldMode - KeyboardInputMode
- The old keyboardInputMode.
- newMode - KeyboardInputMode
- The new keyboardInputMode.
onReparentStripeHandlerChanged
(oldHandler: IReparentStripeHandler, newHandler: IReparentStripeHandler)Called when the reparentStripeHandler property value changes and after initialization of the field.
Parameters
A map of options to pass to the method.
- oldHandler - IReparentStripeHandler
- the old value, which may be
nullthe first time - newHandler - IReparentStripeHandler
- the new value
onReparentStripeInputModeChanged
(oldHandler: ReparentStripeInputMode, newHandler: ReparentStripeInputMode)Called when the reparentStripeInputMode property value changes and after initialization of the field.
Parameters
A map of options to pass to the method.
- oldHandler - ReparentStripeInputMode
- the old value, which may be
nullthe first time - newHandler - ReparentStripeInputMode
- the new value
Called when the resizeStripeInputMode property value changes and after initialization of the field.
Parameters
A map of options to pass to the method.
- oldMode - ResizeStripeInputMode
- the old value, which may be
nullthe first time - newMode - ResizeStripeInputMode
- the new value
Called when the stripeDropInputMode property value changes and after initialization of the field.
Parameters
A map of options to pass to the method.
- oldMode - StripeDropInputMode
- the old value, which may be
nullthe first time - newMode - StripeDropInputMode
- the new value
Removes the given mode from this compound mode.
Parameters
A map of options to pass to the method.
- mode - IInputMode
- The mode to remove.
Defined in
Clears the current selection and selects all stripes in all table instances.
Remarks
See Also
Called when the priority of an installed sub mode has changed.
Remarks
Defined in
Tries to stop all modes.
Returns
- ↪boolean
trueif the editing process was successfully stopped, or if there was no edit in progress to stop; otherwise,false.
See Also
Implements
Uninstalls this mode from the given context.
Remarks
Parameters
A map of options to pass to the method.
- context - IInputModeContext
- The context to deregister from. This is the same instance that had been passed to install during installation.
Overrides
Events
Occurs when an item has been deleted interactively by this mode.
Occurs after all selected items have been removed in deleteSelection.
Occurs just before the deleteSelection method starts its work and will be followed by any number of deleted-item events and finalized by a deleted-selection event.
Occurs when an item has been clicked or tapped.
Remarks
If one of the event handlers sets the handled property to true the event will not be propagated anymore.
Button-specific and input type specific events (item-left-clicked and item-right-clicked) will be raised before this event. If one of those is marked handled this event will not be raised anymore.
See Also
Occurs when an item has been double-clicked or double-tapped.
Remarks
If one of the event handlers sets the handled property to true the event will not be propagated anymore.
Depending on the value of the clickReportingPolicy property of clickInputMode this event may be preceded by no, one, or two item-clicked events (as well as the corresponding button-specific event).
Button-specific and input-type specific events (item-left-double-clicked and item-right-double-clicked) will be raised before this event. If one of those is marked handled this event will not be raised anymore.
See Also
Occurs when an item has been left clicked.
Remarks
true the event will not be propagated anymore. This also means that the item-clicked event will not be raised in that case.See Also
Occurs when an item has been left double clicked.
Remarks
true the event will not be propagated anymore. This also means that the item-double-clicked event will not be raised in that case.See Also
Occurs when an item has been right clicked.
Remarks
true the event will not be propagated anymore. This also means that the item-clicked event will not be raised in that case.See Also
Occurs when an item has been right double clicked.
Remarks
true the event will not be propagated anymore. This also means that the item-double-clicked event will not be raised in that case.