Package org.eclipse.gef.common.activate
Interface IActivatable
-
public interface IActivatableAnIActivatablerepresents 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 theactive propertyAny client implementing this interface may internally use an
ActivatableSupportas a delegate to easily realize the required functionality.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringACTIVE_PROPERTYThe name of theactive property.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidactivate()Activates theIActivatable.javafx.beans.property.ReadOnlyBooleanPropertyactiveProperty()A read-only property providing information about the active state if thisIActivatable.voiddeactivate()Deactivates theIActivatable.booleanisActive()Reports whether thisIActivatableis active or inactive, which resembles the value of theactive property.
-
-
-
Field Detail
-
ACTIVE_PROPERTY
static final java.lang.String ACTIVE_PROPERTY
The name of theactive property.- See Also:
- Constant Field Values
-
-
Method Detail
-
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.- Returns:
- A read-only boolean property which is
truein case theIActivatableis active,falseotherwise.
-
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.
-
-