|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DockTitle
A Component
which is shown aside a Dockable
. A DockTitle
displays some information about its Dockable
, for
example a title-text.
Every DockTitle
is owned by exactly one Dockable
. The owner cannot
be changed.
Every title is either in the state bound
or unbound
.
As long as a title is unbound, it has not to do anything. As soon as it is
bound, it has to ensure that it shows the correct properties. A title
can assume that it is only bound when its Dockable
knows
the DockController
.
Nested Class Summary | |
---|---|
static class |
DockTitle.Orientation
How to layout a DockTitle |
Field Summary | |
---|---|
static PropertyKey<OrientationToRotationStrategy> |
ORIENTATION_STRATEGY
Key for a OrientationToRotationStrategy . |
Method Summary | |
---|---|
void |
addMouseInputListener(javax.swing.event.MouseInputListener listener)
Adds a listener to all Component s of this title
which are visible and which may be "grabbed" by the mouse. |
void |
bind()
Called before this title is displayed. |
void |
changed(DockTitleEvent event)
Called if a property changed that might be important for painting this title. |
java.awt.Component |
getComponent()
Gets a Component which paints this DockTitle . |
Dockable |
getDockable()
Gets the owner of this title. |
DockTitle.Orientation |
getOrientation()
Gets the orientation of this title. |
DockTitleVersion |
getOrigin()
Gets information about how this title was created. |
boolean |
isActive()
Tells whether this title is selected (active) or not. |
void |
removeMouseInputListener(javax.swing.event.MouseInputListener listener)
Removes a listener. |
void |
setOrientation(DockTitle.Orientation orientation)
Sets the orientation of this title. |
void |
unbind()
The reverse of bind() . |
Methods inherited from interface bibliothek.gui.dock.DockElementRepresentative |
---|
getElement, getPopupLocation, isUsedAsTitle, shouldFocus, shouldTransfersFocus |
Field Detail |
---|
static final PropertyKey<OrientationToRotationStrategy> ORIENTATION_STRATEGY
OrientationToRotationStrategy
. The strategy can tell this title how to render its text given
the orientation of this title.
Method Detail |
---|
java.awt.Component getComponent()
Component
which paints this DockTitle
.
This method must always return the same Component
.
getComponent
in interface DockElementRepresentative
Component
void addMouseInputListener(javax.swing.event.MouseInputListener listener)
Component
s of this title
which are visible and which may be "grabbed" by the mouse.
addMouseInputListener
in interface DockElementRepresentative
listener
- the new listenervoid removeMouseInputListener(javax.swing.event.MouseInputListener listener)
removeMouseInputListener
in interface DockElementRepresentative
listener
- the listener to removeDockable getDockable()
void setOrientation(DockTitle.Orientation orientation)
orientation
- the orientationDockTitle.Orientation getOrientation()
setOrientation(bibliothek.gui.dock.title.DockTitle.Orientation)
void changed(DockTitleEvent event)
DockTitleEvent
to transmit more information
to this title than DockTitleEvent
would allow.
event
- information about the current stateboolean isActive()
changed
.
void bind()
owner
.
If the title wants to show some DockActions
(see the method
DockController.listOffers(Dockable)
), then this method
should bind
them too.Dockable.bind(DockTitle)
. The DockController
will call the bind
-method, as soon as the Dockable
knows the controller.
void unbind()
bind()
. The title should remove any connections
to other objects and unbind
its
DockAction
s.Dockable.unbind(DockTitle)
. The DockController
will call the unbind
-method before the Dockable
looses the controller.
DockTitleVersion getOrigin()
DockTitleVersion
can be used
to create a DockTitleRequest
which should create the same title again. If this title
was not created through the regular methods, then this method is allowed
to return null
. However, some features will only work correctly
if this value is not null
.
null
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |