Package org.eclipse.emfforms.spi.swt.treemasterdetail.actions

Class KeybindedMasterDetailAction

java.lang.Object

org.eclipse.core.commands.common.EventManager

org.eclipse.core.commands.AbstractHandler

org.eclipse.emfforms.spi.swt.treemasterdetail.actions.MasterDetailAction

org.eclipse.emfforms.spi.swt.treemasterdetail.actions.KeybindedMasterDetailAction

All Implemented Interfaces:

java.util.EventListener, org.eclipse.core.commands.IHandler, org.eclipse.core.commands.IHandler2, org.eclipse.jface.viewers.ISelectionChangedListener, org.eclipse.swt.events.KeyListener, org.eclipse.swt.internal.SWTEventListener

Direct Known Subclasses:

DelegatingMasterDetailAction

public abstract class KeybindedMasterDetailAction
extends MasterDetailAction
implements org.eclipse.swt.events.KeyListener, org.eclipse.jface.viewers.ISelectionChangedListener

Extended MasterDetailAction to help introduce keybindings.

Since:

1.8

Author:

Stefan Dirix

Constructor Summary

Constructors

Constructor	Description
KeybindedMasterDetailAction()

Method Summary

Modifier and Type	Method	Description
protected void	executeOnKeyPressed(org.eclipse.jface.viewers.ISelection currentSelection)	This method is triggered by isExecuteOnKeyPressed(KeyEvent) when a KeyEvent is triggered by a key press.
protected abstract void	executeOnKeyRelease(org.eclipse.jface.viewers.ISelection currentSelection)	This method is triggered by isExecuteOnKeyRelease(KeyEvent) when a KeyEvent is triggered by a key release.
protected org.eclipse.jface.viewers.ISelection	getCurrentSelection()	Returns the current ISelection.
protected static boolean	isActivated(org.eclipse.swt.events.KeyEvent event, int swtMask, char c)	Determines if the keys indicated by the SWT swtMask and c are active.
protected boolean	isExecuteOnKeyPressed(org.eclipse.swt.events.KeyEvent event)	Determines if the executeOnKeyPressed(ISelection) method shall be executed.
protected boolean	isExecuteOnKeyRelease()
protected abstract boolean	isExecuteOnKeyRelease(org.eclipse.swt.events.KeyEvent event)	Determines if the executeOnKeyRelease(ISelection) method shall be executed.
void	keyPressed(org.eclipse.swt.events.KeyEvent event)
void	keyReleased(org.eclipse.swt.events.KeyEvent event)
void	selectionChanged(org.eclipse.jface.viewers.SelectionChangedEvent event)
protected void	setExecuteOnKeyRelease(boolean executeOnKeyRelease)
void	setTreeViewer(org.eclipse.jface.viewers.TreeViewer treeviewer)	Sets the treeviewer of the tree master detail composite.

Methods inherited from class org.eclipse.emfforms.spi.swt.treemasterdetail.actions.MasterDetailAction

execute, getImagePath, getLabel, getTreeViewer, setImagePath, setLabel, shouldShow

Methods inherited from class org.eclipse.core.commands.AbstractHandler

addHandlerListener, dispose, fireHandlerChanged, hasListeners, isEnabled, isHandled, removeHandlerListener, setBaseEnabled, setEnabled

Methods inherited from class org.eclipse.core.commands.common.EventManager

addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.core.commands.IHandler

execute

Constructor Detail

KeybindedMasterDetailAction

public KeybindedMasterDetailAction()

Method Detail

setTreeViewer

public void setTreeViewer(org.eclipse.jface.viewers.TreeViewer treeviewer)

Sets the treeviewer of the tree master detail composite.

Overrides:

setTreeViewer in class MasterDetailAction

Parameters:

treeviewer - the tree

See Also:

MasterDetailAction.setTreeViewer(org.eclipse.jface.viewers.TreeViewer)

selectionChanged

public void selectionChanged(org.eclipse.jface.viewers.SelectionChangedEvent event)

Specified by:

selectionChanged in interface org.eclipse.jface.viewers.ISelectionChangedListener

See Also:

ISelectionChangedListener.selectionChanged(org.eclipse.jface.viewers.SelectionChangedEvent)

getCurrentSelection

protected org.eclipse.jface.viewers.ISelection getCurrentSelection()

Returns the current ISelection.

Returns:

The current ISelection if there is one, null otherwise.

keyPressed

public void keyPressed(org.eclipse.swt.events.KeyEvent event)

Specified by:

keyPressed in interface org.eclipse.swt.events.KeyListener

See Also:

KeyListener.keyPressed(org.eclipse.swt.events.KeyEvent)

isExecuteOnKeyPressed

protected boolean isExecuteOnKeyPressed(org.eclipse.swt.events.KeyEvent event)

Determines if the executeOnKeyPressed(ISelection) method shall be executed.

Parameters:

event - The KeyEvent which triggers this method.

Returns:

true if executeOnKeyPressed(ISelection) method shall be called, false otherwise.

executeOnKeyPressed

protected void executeOnKeyPressed(org.eclipse.jface.viewers.ISelection currentSelection)

This method is triggered by isExecuteOnKeyPressed(KeyEvent) when a KeyEvent is triggered by a key press.

Parameters:

currentSelection - The current ISelection.

keyReleased

public void keyReleased(org.eclipse.swt.events.KeyEvent event)

Specified by:

keyReleased in interface org.eclipse.swt.events.KeyListener

See Also:

KeyListener.keyReleased(org.eclipse.swt.events.KeyEvent)

isExecuteOnKeyRelease

protected abstract boolean isExecuteOnKeyRelease(org.eclipse.swt.events.KeyEvent event)

Determines if the executeOnKeyRelease(ISelection) method shall be executed.

Parameters:

event - The KeyEvent on Keypress. This allows to react on key combinations even on key release

Returns:

true if executeOnKeyRelease(ISelection) method shall be called, false otherwise.

executeOnKeyRelease

protected abstract void executeOnKeyRelease(org.eclipse.jface.viewers.ISelection currentSelection)

This method is triggered by isExecuteOnKeyRelease(KeyEvent) when a KeyEvent is triggered by a key release.

Parameters:

currentSelection - The current ISelection.

isActivated

protected static boolean isActivated(org.eclipse.swt.events.KeyEvent event,
                                     int swtMask,
                                     char c)

Determines if the keys indicated by the SWT swtMask and c are active.

Parameters:

event - The KeyEvent to check.

swtMask - SWT key event mask, e.g. SWT.CTRL, SWT.ALT etc.

c - The additional pressed char. Use KeyEvent.keyCode if you only want to check for swtMask.

Returns:

true if the keys indicated by swtMask and c are active, false otherwise.

isExecuteOnKeyRelease

protected boolean isExecuteOnKeyRelease()

Returns:

the executeOnKeyRelease

Since:

1.14

setExecuteOnKeyRelease

protected void setExecuteOnKeyRelease(boolean executeOnKeyRelease)

Parameters:

executeOnKeyRelease - the executeOnKeyRelease to set

Since:

1.14