public interface ExtendedModeEnablement
Dockable
s whether some ExtendedMode
is
available or not.Modifier and Type | Interface and Description |
---|---|
static class |
ExtendedModeEnablement.Availability
A measurement of how available a certain mode is.
|
static class |
ExtendedModeEnablement.Hidden
A measurement of how hidden a certain mode is.
|
Modifier and Type | Method and Description |
---|---|
void |
addListener(ExtendedModeEnablementListener listener)
Adds a listener to this enablement, the listener has be informed if the availability state of
a mode in respect to a dockable has changed.
|
void |
destroy()
Informs this enablement that it is no longer of any use.
|
ExtendedModeEnablement.Availability |
isAvailable(Dockable dockable,
ExtendedMode mode)
Tells whether
mode is available for dockable .Note: for ExtendedMode.NORMALIZED the result should always be true . |
ExtendedModeEnablement.Hidden |
isHidden(Dockable dockable,
ExtendedMode mode)
Tells whether
mode is hidden from the user for dockable . |
void |
removeListener(ExtendedModeEnablementListener listener)
Removes a listener from this enablement.
|
ExtendedModeEnablement.Availability isAvailable(Dockable dockable, ExtendedMode mode)
mode
is available for dockable
.ExtendedMode.NORMALIZED
the result should always be true
.dockable
- some element, not null
mode
- some mode, not null
ExtendedModeEnablement.Availability.WEAK_AVAILABLE
if mode
equals ExtendedMode.NORMALIZED
.
Must never be null
, but a result of ExtendedModeEnablement.Availability.UNCERTAIN
indicates that this enablement does not knowExtendedModeEnablement.Hidden isHidden(Dockable dockable, ExtendedMode mode)
mode
is hidden from the user for dockable
. If a mode
is hidden it can still be available, the user will just not be informed (e.g. there is no button
that will move the dockable).dockable
- some element, not null
mode
- some mode, not null
mode
is hidden from the user when looking at dockable
void addListener(ExtendedModeEnablementListener listener)
Dockable
s that are registered
at the LocationModeManager
have to be observed.listener
- the new listenervoid removeListener(ExtendedModeEnablementListener listener)
listener
- the listener to removevoid destroy()