org.eclipse.gef4.mvc.models

Class FocusModel<VR>

java.lang.Object

org.eclipse.gef4.mvc.models.FocusModel<VR>

Type Parameters:

VR - The visual root node of the UI toolkit used, e.g. javafx.scene.Node in case of JavaFX.

All Implemented Interfaces:

IPropertyChangeNotifier

public class FocusModel<VR>
extends java.lang.Object
implements IPropertyChangeNotifier

The FocusModel stores the IContentPart which has keyboard focus. Note that you are responsible for synchronizing keyboard focus with the model.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FOCUS_PROPERTY The FocusModel fires PropertyChangeEvents when the focused part changes.
static java.lang.String	VIEWER_FOCUS_PROPERTY The FocusModel fires PropertyChangeEvents when the viewer focused state changes.

Constructor Summary

Constructors

Constructor and Description
FocusModel() Constructs a new FocusModel.

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(java.beans.PropertyChangeListener listener)
IContentPart<VR,? extends VR>	getFocused() Returns the IContentPart which has keyboard focus, or null if no IContentPart currently has keyboard focus.
boolean	isViewerFocused() Returns true if the viewer where this model is registered currently has keyboard focus.
void	removePropertyChangeListener(java.beans.PropertyChangeListener listener)
void	setFocused(IContentPart<VR,? extends VR> focusPart) Selects the given IContentPart as the focus part.
void	setViewerFocused(boolean viewerFocused) Updates the isViewerFocused() property of this model.

Methods inherited from class java.lang.Object

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

Field Detail

FOCUS_PROPERTY

public static final java.lang.String FOCUS_PROPERTY

The FocusModel fires PropertyChangeEvents when the focused part changes. This is the name of the property that is delivered with the event.

See Also:

setFocused(IContentPart), Constant Field Values

VIEWER_FOCUS_PROPERTY

public static final java.lang.String VIEWER_FOCUS_PROPERTY

The FocusModel fires PropertyChangeEvents when the viewer focused state changes. This is the name of the property that is delivered with the event.

See Also:

setViewerFocused(boolean), Constant Field Values

Constructor Detail

FocusModel

public FocusModel()

Constructs a new FocusModel. The focused IContentPart is set to null and the isViewerFocused() flag is set to false.

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Specified by:

addPropertyChangeListener in interface IPropertyChangeNotifier

getFocused

public IContentPart<VR,? extends VR> getFocused()

Returns the IContentPart which has keyboard focus, or null if no IContentPart currently has keyboard focus.

Returns:

the IContentPart which has keyboard focus, or null

isViewerFocused

public boolean isViewerFocused()

Returns true if the viewer where this model is registered currently has keyboard focus. Otherwise returns false.

Returns:

true if the viewer where this model is registered currently has keyboard focus. Otherwise returns false.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Specified by:

removePropertyChangeListener in interface IPropertyChangeNotifier

setFocused

public void setFocused(IContentPart<VR,? extends VR> focusPart)

Selects the given IContentPart as the focus part. Note that setting the focus part does not assign keyboard focus to the part.

Parameters:

focusPart - The IContentPart which should become the new focus part.

setViewerFocused

public void setViewerFocused(boolean viewerFocused)

Updates the isViewerFocused() property of this model.

Parameters:

viewerFocused - true to indicate that the viewer has keyboard focus, or false to indicate that the viewer does not have keyboard focus.