public class DockTitleVersion extends java.lang.Object implements DockTitleFactory
DockTitleVersion
is a hint which DockTitleFactory
has to
be used to create one or more DockTitle
for some Dockable
.DockTitleVersions
are created and registered by a DockTitleManager
.DockTitleVersion
implements DockTitleFactory
for convenience.Modifier and Type | Field and Description |
---|---|
static Path |
DOCK_TITLE_VERSION_EXTENSION
|
static java.lang.String |
DOCK_TITLE_VERSION_EXTENSION_PARAMETER
Name of the only property of an
ExtensionName , the property points to this |
Constructor and Description |
---|
DockTitleVersion(DockController controller,
java.lang.String id)
Creates a new version.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
DockController |
getController()
Gets the controller for which the titles are created.
|
DockTitleFactory |
getFactory()
Gets the factory with the highest priority
|
DockTitleFactory |
getFactory(Priority priority)
Gets the factory with the given priority.
|
java.lang.String |
getID()
Gets the name of this version.
|
int |
hashCode() |
void |
install(DockTitleRequest request)
Adds
request to this version. |
boolean |
isSet(Priority priority)
Tells whether there is a factory with the importance
priority ,
or not. |
void |
request()
Calls
DockTitleRequest.request() for all DockTitleRequest s
that are currently installed on this version. |
void |
request(DockTitleRequest request)
Calls
DockTitleFactory.request(DockTitleRequest) for the current
factory. |
void |
setFactory(DockTitleFactory factory,
Priority priority)
Stores
factory at the slot priority . |
void |
uninstall(DockTitleRequest request)
Removes
request from this version. |
public static final Path DOCK_TITLE_VERSION_EXTENSION
ExtensionName
that allows to load additional DockFactory
s into this
DockTitleVersion
. These factories will be asked to create a DockTitle
before
the real factory is asked.public static final java.lang.String DOCK_TITLE_VERSION_EXTENSION_PARAMETER
ExtensionName
, the property points to this
public DockTitleVersion(DockController controller, java.lang.String id)
controller
- the controller for which titles will be createdid
- the unique name of this versionpublic void install(DockTitleRequest request)
request
to this version. The request
will
be installed on the current DockTitleFactory
of this version.
This method should not be called by clients, clients should call DockTitleRequest.install()
.install
in interface DockTitleFactory
request
- the new request, not null
public void uninstall(DockTitleRequest request)
request
from this version. This method should not be
called by clients, clients should call DockTitleRequest.uninstall()
.uninstall
in interface DockTitleFactory
request
- the request to removepublic void request(DockTitleRequest request)
DockTitleFactory.request(DockTitleRequest)
for the current
factory. If there are any extensions
installed, then
these extensions are questioned first.request
in interface DockTitleFactory
request
- the request to answerpublic void request()
DockTitleRequest.request()
for all DockTitleRequest
s
that are currently installed on this version.public DockTitleFactory getFactory()
null
if there is no
factory registered.public void setFactory(DockTitleFactory factory, Priority priority)
factory
at the slot priority
.factory
- the factorypriority
- the importance of the factorypublic DockTitleFactory getFactory(Priority priority)
priority
- the prioritynull
public boolean isSet(Priority priority)
priority
,
or not.priority
- the searched prioritytrue
if there is a factorypublic int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public java.lang.String getID()
DockTitleManager
.public DockController getController()