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:

IDisposable

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

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

Property Summary

Type	Property and Description
javafx.beans.property.ObjectProperty<IContentPart<VR,? extends VR>>	focus Returns an object property providing the currently focused IContentPart.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
FocusModel() Constructs a new FocusModel.

Method Summary

Modifier and Type	Method and Description
void	dispose()
javafx.beans.property.ObjectProperty<IContentPart<VR,? extends VR>>	focusProperty() Returns an object property providing the currently focused IContentPart.
IContentPart<VR,? extends VR>	getFocus() Returns the IContentPart which has keyboard focus, or null if no IContentPart currently has keyboard focus.
void	setFocus(IContentPart<VR,? extends VR> focusPart) Selects the given IContentPart as the focus part.

Methods inherited from class java.lang.Object

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

Property Detail

focus

public javafx.beans.property.ObjectProperty<IContentPart<VR,? extends VR>> focusProperty

Returns an object property providing the currently focused IContentPart.

See Also:

getFocus(), setFocus(IContentPart)

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:

setFocus(IContentPart), Constant Field Values

Constructor Detail

FocusModel

public FocusModel()

Constructs a new FocusModel. The focused IContentPart is set to null.

Method Detail

dispose

public void dispose()

Specified by:

dispose in interface IDisposable

Since:

1.1

focusProperty

public javafx.beans.property.ObjectProperty<IContentPart<VR,? extends VR>> focusProperty()

Returns an object property providing the currently focused IContentPart.

See Also:

getFocus(), setFocus(IContentPart)

getFocus

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

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

setFocus

public void setFocus(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.