org.eclipse.gef4.common.activate

Class ActivatableSupport

java.lang.Object

org.eclipse.gef4.common.activate.ActivatableSupport

public class ActivatableSupport
extends java.lang.Object

A support class to manage the activeProperty state for a source IActivatable. It offers all methods defined by IActivatable, while not formally implementing the interface, and can thus be used by a source IActivatable as a delegate.

If the given IActivatable is also IAdaptable, all calls to activate() and deactivate() will be forwarded to all adapters registered at the IActivatable at that moment. However, the ActivatableSupport will not register a change listener on the IAdaptable to get notified about newly set or unset adapters, so they will not be automatically activated/deactivated. The source IActivatable may use an AdaptableSupport as a second delegate for this purpose.

Property Summary

Type	Property and Description
javafx.beans.property.ReadOnlyBooleanProperty	active Returns a ReadOnlyBooleanProperty that reflects the activeProperty state of this ActivatableSupport.

Constructor Summary

Constructors

Constructor and Description
ActivatableSupport(IActivatable source) Creates a new ActivatableSupport for the given source IActivatable.

Method Summary

Modifier and Type	Method and Description
void	activate() Activates this ActivatableSupport if it is not yet activeProperty.
javafx.beans.property.ReadOnlyBooleanProperty	activeProperty() Returns a ReadOnlyBooleanProperty that reflects the activeProperty state of this ActivatableSupport.
void	deactivate() Deactivates this ActivatableSupport if it is not yet inactive.
boolean	isActive() Reports whether this ActivatableSupport is activeProperty or inactive.

Methods inherited from class java.lang.Object

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

Property Detail

active

public javafx.beans.property.ReadOnlyBooleanProperty activeProperty

Returns a ReadOnlyBooleanProperty that reflects the activeProperty state of this ActivatableSupport.

See Also:

isActive()

Constructor Detail

ActivatableSupport

public ActivatableSupport(IActivatable source)

Creates a new ActivatableSupport for the given source IActivatable.

Parameters:

source - The IActivatable that encloses the to be created ActivatableSupport, delegating calls to it. May not be null

Method Detail

activate

public void activate()

Activates this ActivatableSupport if it is not yet activeProperty. Will first adjust the activeProperty state, then activate any IActivatable adapters, being registered at the source IActivatable.

See Also:

IActivatable.activate()

activeProperty

public javafx.beans.property.ReadOnlyBooleanProperty activeProperty()

Returns a ReadOnlyBooleanProperty that reflects the activeProperty state of this ActivatableSupport.

See Also:

isActive()

deactivate

public void deactivate()

Deactivates this ActivatableSupport if it is not yet inactive. Will first deactivate any IActivatable adapters, being registered at the source IActivatable, then adjust the activeProperty state.

See Also:

IActivatable.deactivate()

isActive

public boolean isActive()

Reports whether this ActivatableSupport is activeProperty or inactive.

Returns:

true in case the ActivatableSupport is activeProperty, false otherwise.

See Also:

IActivatable.isActive()