Package org.eclipse.gef.common.activate
Interface IActivatable
public interface IActivatable
An
IActivatable represents an entity that can be activated (
activate()) and deactivated (deactivate()) as required.
The current activation state of an IActivatable (whether the entity
is active or not) can be queried by clients (isActive()) and changes
to it can be observed via the active property
Any client implementing this interface may internally use an
ActivatableSupport as a delegate to easily realize the required
functionality.
-
Property Summary
PropertiesTypePropertyDescriptionjavafx.beans.property.ReadOnlyBooleanPropertyA read-only property providing information about the active state if thisIActivatable. -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoidactivate()Activates theIActivatable.javafx.beans.property.ReadOnlyBooleanPropertyA read-only property providing information about the active state if thisIActivatable.voidDeactivates theIActivatable.booleanisActive()Reports whether thisIActivatableis active or inactive, which resembles the value of theactive property.
-
Property Details
-
active
javafx.beans.property.ReadOnlyBooleanProperty activePropertyA read-only property providing information about the active state if thisIActivatable.- See Also:
-
-
Field Details
-
ACTIVE_PROPERTY
The name of theactive property.- See Also:
-
-
Method Details
-
activate
void activate()Activates theIActivatable. It is expected that a call toisActive()returnstrueafter this method has been called (unlessdeactivate()is called to deactivate theIActivatable). -
activeProperty
javafx.beans.property.ReadOnlyBooleanProperty activeProperty()A read-only property providing information about the active state if thisIActivatable.- See Also:
-
deactivate
void deactivate()Deactivates theIActivatable. It is expected that a call toisActive()returnfalseafter this method has been called (unless {activate()is called to re-activate theIAdaptable. -
isActive
boolean isActive()Reports whether thisIActivatableis active or inactive, which resembles the value of theactive property.- Returns:
truein case theIActivatableis active,falseotherwise.
-