|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.awt.Component java.awt.Container javax.swing.JComponent javax.swing.JPanel bibliothek.gui.dock.util.BackgroundPanel bibliothek.gui.dock.util.ConfiguredBackgroundPanel bibliothek.gui.dock.title.AbstractMultiDockTitle bibliothek.gui.dock.title.AbstractDockTitle
public class AbstractDockTitle
An abstract implementation of DockTitle
. This title can have
an icon, a title-text and some small buttons to display actions
.
The icon is at the top or left edge, the text in the middle, and the actions
at the lower or the right edge of the title. If the orientation of the
title is set to vertical
, the text will be rotated
by 90 degrees.
This title has also an ActionPopup
which will appear when the user
presses the right mouse-button. The popup shows a list of all actions known
to this title.
The whole logic a DockTitle
needs is implemented in this class,
but subclasses may add graphical features - like a border or another
background.
Subclasses may override AbstractMultiDockTitle.getInnerInsets()
to add a space between
border and contents of this title.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class javax.swing.JPanel |
---|
JPanel.AccessibleJPanel |
Nested classes/interfaces inherited from class javax.swing.JComponent |
---|
JComponent.AccessibleJComponent |
Nested classes/interfaces inherited from class java.awt.Container |
---|
Container.AccessibleAWTContainer |
Nested classes/interfaces inherited from class java.awt.Component |
---|
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy |
Nested classes/interfaces inherited from interface bibliothek.gui.dock.title.DockTitle |
---|
DockTitle.Orientation |
Field Summary |
---|
Fields inherited from class javax.swing.JComponent |
---|
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW |
Fields inherited from class java.awt.Component |
---|
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT |
Fields inherited from interface bibliothek.gui.dock.title.DockTitle |
---|
ORIENTATION_STRATEGY |
Fields inherited from interface java.awt.image.ImageObserver |
---|
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
Constructor Summary | |
---|---|
protected |
AbstractDockTitle()
Constructor which does not do anything. |
|
AbstractDockTitle(Dockable dockable,
DockTitleVersion origin)
Constructs a new title |
|
AbstractDockTitle(Dockable dockable,
DockTitleVersion origin,
boolean showMiniButtons)
Standard constructor |
Method Summary | |
---|---|
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. |
protected void |
doTitleLayout()
Updates the layout (position and size of all children) of this title. |
protected DockActionSource |
getActionSourceFor(Dockable dockable)
Gets a list of all actions which will be shown on this title. |
Point |
getPopupLocation(Point click,
boolean popupTrigger)
Tells whether a popup menu should be opened when the user clicks at click with the mouse. |
Dimension |
getPreferredSize()
|
protected DockActionSource |
getSuggestedSource()
Gets the DockActionSource that was suggested to this
title. |
protected void |
init(Dockable dockable,
DockTitleVersion origin,
boolean showMiniButtons)
Initializer called by the constructor. |
boolean |
isShowMiniButtons()
Tells whether this titel is able to show any DockAction . |
void |
setOrientation(DockTitle.Orientation orientation)
Sets the orientation of this title. |
void |
setShowMiniButtons(boolean showMiniButtons)
Enables or disables DockAction s for this title. |
protected void |
setTooltip(String text)
Sets the tooltip that will be shown on this title. |
protected void |
suggestActions(DockActionSource actions)
Called if a module using the DockTitle suggests using a specific set of DockAction s. |
void |
unbind()
The reverse of DockTitle.bind() . |
Methods inherited from class bibliothek.gui.dock.util.ConfiguredBackgroundPanel |
---|
configure |
Methods inherited from class bibliothek.gui.dock.util.BackgroundPanel |
---|
getBackgroundAlgorithm, getComponent, getTransparency, paint, paintBorder, paintChildren, paintComponent, paintOverlay, setBackground, setTransparency |
Methods inherited from class javax.swing.JPanel |
---|
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface bibliothek.gui.dock.title.DockTitle |
---|
getComponent |
Constructor Detail |
---|
public AbstractDockTitle(Dockable dockable, DockTitleVersion origin)
dockable
- the Dockable which is the owner of this titleorigin
- the version which was used to create this titlepublic AbstractDockTitle(Dockable dockable, DockTitleVersion origin, boolean showMiniButtons)
dockable
- The Dockable whose title this will beorigin
- The version which was used to create this titleshowMiniButtons
- true
if the actions of the Dockable
should be shown, false
if they should not be visibleprotected AbstractDockTitle()
init(Dockable, DockTitleVersion, boolean)
to initialize
the title.
Method Detail |
---|
protected void init(Dockable dockable, DockTitleVersion origin, boolean showMiniButtons)
dockable
- The Dockable whose title this will beorigin
- The version which was used to create this titleshowMiniButtons
- true
if the actions of the Dockable
should be shown, false
if they should not be visiblepublic boolean isShowMiniButtons()
DockAction
.
true
if DockAction
s are enabledsetShowMiniButtons(boolean)
public void setShowMiniButtons(boolean showMiniButtons)
DockAction
s for this title.
showMiniButtons
- whether to show actions or notprotected void setTooltip(String text)
setTooltip
in class AbstractMultiDockTitle
text
- the new tooltip, can be null
public void setOrientation(DockTitle.Orientation orientation)
DockTitle
setOrientation
in interface DockTitle
setOrientation
in class AbstractMultiDockTitle
orientation
- the orientationprotected void doTitleLayout()
AbstractMultiDockTitle
doTitleLayout
in class AbstractMultiDockTitle
public Point getPopupLocation(Point click, boolean popupTrigger)
DockElementRepresentative
click
with the mouse. If yes, then the top left edge
of the popup should be returned, otherwise null
should be
returned.
getPopupLocation
in interface DockElementRepresentative
getPopupLocation
in class AbstractMultiDockTitle
click
- the location where the user clicked with the mousepopupTrigger
- whether the invocation is the systems popup trigger
or not. Many implementations of this method will return click
in case of true
, and null
in case of false
null
if no
popup-menu should be openedpublic void changed(DockTitleEvent event)
DockTitle
DockTitleEvent
to transmit more information
to this title than DockTitleEvent
would allow.
changed
in interface DockTitle
changed
in class AbstractMultiDockTitle
event
- information about the current statepublic Dimension getPreferredSize()
getPreferredSize
in class AbstractMultiDockTitle
protected DockActionSource getActionSourceFor(Dockable dockable)
dockable
- the owner of the actions
protected void suggestActions(DockActionSource actions)
DockTitle
suggests using a specific set of DockAction
s. It is
up to the DockTitle
to follow the suggestions or to ignore them. The default behavior of this
AbstractDockTitle
is to set the result of getActionSourceFor(Dockable)
equal to
actions
and update the itemPanel
if necessary.
actions
- the set of actions that should be usedprotected DockActionSource getSuggestedSource()
DockActionSource
that was suggested
to this
title.
null
public void bind()
DockTitle
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.
bind
in interface DockTitle
bind
in class AbstractMultiDockTitle
public void unbind()
DockTitle
DockTitle.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.
unbind
in interface DockTitle
unbind
in class AbstractMultiDockTitle
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |