org.eclipse.fx.ui.controls.styledtext

Class TriggerActionMapping

java.lang.Object

org.eclipse.fx.ui.controls.styledtext.TriggerActionMapping

public class TriggerActionMapping
extends java.lang.Object

Mapping for user input triggers to actions to allow customization. This is an experimental component provided as a preview we'll improve and fix problems in up coming releases

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TriggerActionMapping.Context

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<java.util.function.BiFunction<TextEditAction,TriggerActionMapping.Context,java.lang.Boolean>>	eventHandler

Constructor Summary

Constructors

Constructor and Description
TriggerActionMapping()

Method Summary

Modifier and Type	Method and Description
boolean	exists(char c)
boolean	exists(javafx.scene.input.KeyEvent event)
java.util.Optional<TextEditAction>	get(char typedChar)
java.util.Optional<TextEditAction>	get(javafx.scene.input.KeyCombination combo)
java.util.Optional<TextEditAction>	get(javafx.scene.input.KeyEvent event)
void	map(char typedChar, TextEditAction action)
void	map(java.lang.String keyCombo, TextEditAction action)
void	mapConditional(java.lang.String conditionId, java.util.function.Supplier<java.lang.Boolean> condition, char typedChar, TextEditAction action)
void	mapConditional(java.lang.String conditionId, java.util.function.Supplier<java.lang.Boolean> condition, java.lang.String keyCombo, TextEditAction action)
javafx.beans.property.ObjectProperty<TriggerActionMapping>	overrideProperty()
void	setOverride(TriggerActionMapping override)
Subscription	subscribe(java.util.function.BiFunction<TextEditAction,TriggerActionMapping.Context,java.lang.Boolean> handler)
boolean	triggerAction(char typedChar, TriggerActionMapping.Context context)
boolean	triggerAction(javafx.scene.input.KeyCombination combo, TriggerActionMapping.Context context)
boolean	triggerAction(javafx.scene.input.KeyEvent event, TriggerActionMapping.Context context)
boolean	triggerAction(TextEditAction action, TriggerActionMapping.Context context)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

eventHandler

protected java.util.List<java.util.function.BiFunction<TextEditAction,TriggerActionMapping.Context,java.lang.Boolean>> eventHandler

Constructor Detail

TriggerActionMapping

public TriggerActionMapping()

Method Detail

overrideProperty

public javafx.beans.property.ObjectProperty<TriggerActionMapping> overrideProperty()

setOverride

public void setOverride(TriggerActionMapping override)

map

public void map(java.lang.String keyCombo,
                TextEditAction action)

map

public void map(char typedChar,
                TextEditAction action)

mapConditional

public void mapConditional(java.lang.String conditionId,
                           java.util.function.Supplier<java.lang.Boolean> condition,
                           java.lang.String keyCombo,
                           TextEditAction action)

mapConditional

public void mapConditional(java.lang.String conditionId,
                           java.util.function.Supplier<java.lang.Boolean> condition,
                           char typedChar,
                           TextEditAction action)

get

public java.util.Optional<TextEditAction> get(javafx.scene.input.KeyCombination combo)

get

public java.util.Optional<TextEditAction> get(javafx.scene.input.KeyEvent event)

get

public java.util.Optional<TextEditAction> get(char typedChar)

triggerAction

public boolean triggerAction(javafx.scene.input.KeyCombination combo,
                             TriggerActionMapping.Context context)

triggerAction

public boolean triggerAction(javafx.scene.input.KeyEvent event,
                             TriggerActionMapping.Context context)

exists

public boolean exists(javafx.scene.input.KeyEvent event)

exists

public boolean exists(char c)

triggerAction

public boolean triggerAction(char typedChar,
                             TriggerActionMapping.Context context)

triggerAction

public boolean triggerAction(TextEditAction action,
                             TriggerActionMapping.Context context)

subscribe

public Subscription subscribe(java.util.function.BiFunction<TextEditAction,TriggerActionMapping.Context,java.lang.Boolean> handler)