org.eclipse.gef.mvc.fx.models

Class FocusModel

java.lang.Object

org.eclipse.gef.common.adapt.IAdaptable.Bound.Impl<IViewer>

org.eclipse.gef.mvc.fx.models.FocusModel

All Implemented Interfaces:

IAdaptable.Bound<IViewer>, IDisposable

public class FocusModel
extends IAdaptable.Bound.Impl<IViewer>
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
ObjectProperty<IContentPart<? extends Node>>	focus Returns an object property providing the currently focused IContentPart.

Properties inherited from class org.eclipse.gef.common.adapt.IAdaptable.Bound.Impl

adaptable

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.gef.common.adapt.IAdaptable.Bound

IAdaptable.Bound.Impl<T extends IAdaptable>

Field Summary

Fields

Modifier and Type	Field and Description
static 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()
ObjectProperty<IContentPart<? extends Node>>	focusProperty() Returns an object property providing the currently focused IContentPart.
IContentPart<? extends Node>	getFocus() Returns the IContentPart which has keyboard focus, or null if no IContentPart currently has keyboard focus.
void	setAdaptable(IViewer adaptable)
void	setFocus(IContentPart<? extends Node> focusPart) Selects the given IContentPart as the focus part.

Methods inherited from class org.eclipse.gef.common.adapt.IAdaptable.Bound.Impl

adaptableProperty, getAdaptable

Methods inherited from class java.lang.Object

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

Property Detail

focus

public ObjectProperty<IContentPart<? extends Node>> focusProperty

Returns an object property providing the currently focused IContentPart.

See Also:

getFocus(), setFocus(IContentPart)

Field Detail

FOCUS_PROPERTY

public static final 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 ObjectProperty<IContentPart<? extends Node>> focusProperty()

Returns an object property providing the currently focused IContentPart.

See Also:

getFocus(), setFocus(IContentPart)

getFocus

public IContentPart<? extends Node> 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

setAdaptable

public void setAdaptable(IViewer adaptable)

Specified by:

setAdaptable in interface IAdaptable.Bound<IViewer>

Overrides:

setAdaptable in class IAdaptable.Bound.Impl<IViewer>

setFocus

public void setFocus(IContentPart<? extends Node> 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.