|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JPanel
com.vlsolutions.swing.docking.DockView
public class DockView
DefaultImplementation of the SingleDockableContainer.
A Dockview is the component responsible for displaying a single user component inside a DockingPanel.
The DockView contains a DockViewTitleBar, used as a header to display useful information and optional controls (close/maximize/hide/float)
UI : The user component is displayed with decorations provided by a
DockViewUI
delegate.
Here is an example (VLDocking 1.1 "shadow" style) :
Note : multiple user-components are not displayable by the dockview :
the default implementation of TabbedDockableContainer is the DockTabbedPane
.
DockViewTitleBar
,
Serialized FormNested 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 |
Field Summary | |
---|---|
protected DockingDesktop |
desktop
the desktop managing this view |
protected Dockable |
dockable
the dockable managed by this view |
protected Shape |
lastDropGeneralPath
remember the last drop position to cache the shape used for showing the drop position |
protected Shape |
lastDropShape
remember the last drop position to cache the shape used for showing the drop position |
protected DockViewTitleBar |
title
|
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 java.awt.image.ImageObserver |
---|
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
Constructor Summary | |
---|---|
DockView()
Constructs an empty DockView. |
|
DockView(Dockable dockable)
Constructs a new DockView for the given dockable. |
|
DockView(Dockable dockable,
boolean showTitle)
Constructs a new DockView for the given dockable. |
Method Summary | |
---|---|
protected GeneralPath |
buildPathForTab(Rectangle bounds)
Create a path used to display the drag shape of a tab container |
Dockable |
getDockable()
Returns the contained component Returns the dockable this container is displaying |
DockViewTitleBar |
getTitleBar()
Returns the title bar of this dockview |
String |
getUIClassID()
|
void |
installDocking(DockingDesktop desktop)
Invoked once after creation, in order to let this component register its DockableDragSources to the DockingDesktop, and have a reference of this Desktop. |
void |
processDockableDrag(DockDragEvent event)
The component is notified of a drag operation. |
void |
processDockableDrop(DockDropEvent event)
The component is requested to perform a docking drop action. |
protected void |
scanDrop(DockEvent event,
boolean drop)
|
void |
setDockable(Dockable dockable)
Adds the dockable's component to this DockView. |
String |
toString()
|
void |
uninstallDocking(DockingDesktop desktop)
Called once, when the dockablecontainer is no longer used by the desktop, in order to releases resources and listeners taken on installDocking() |
Methods inherited from class javax.swing.JPanel |
---|
getAccessibleContext, getUI, paramString, setUI, updateUI |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
protected DockViewTitleBar title
protected DockingDesktop desktop
protected Dockable dockable
protected Shape lastDropShape
protected Shape lastDropGeneralPath
Constructor Detail |
---|
public DockView()
A setDockable(Dockable)
call is requiered for this constructor to be usefull.
public DockView(Dockable dockable)
dockable
- the dockable to showpublic DockView(Dockable dockable, boolean showTitle)
dockable
- the dockable to showMethod Detail |
---|
public Dockable getDockable()
getDockable
in interface SingleDockableContainer
public void setDockable(Dockable dockable)
dockable
- the user dockablepublic String toString()
toString
in class Component
public String getUIClassID()
getUIClassID
in class JPanel
public void processDockableDrag(DockDragEvent event)
This method is used to give a visual clue of dropping capability (for example, mouse cursor change, painting a shadow of future component position)
These clues are transmitted via the event's methods..
processDockableDrag
in interface DockDropReceiver
DockDragEvent
,
DockDropEvent
public void processDockableDrop(DockDropEvent event)
This method is called only after a successful DockDropReceiver.processDockableDrag(DockDragEvent)
The parameters provided for the drop are the same than those of the last drag (in order to avoid an allowed last drag followed by a rejected drop).
On event acceptation ( DockDropEvent.acceptDrop()
, the source component
will be removed from its container, so the DropReceiver must add the
component to its own hierarchy otherwise
the component would be lost (from a user's point of view).
Please note that a drag into a DockView can also lead to create a DockTabbedPane.
processDockableDrop
in interface DockDropReceiver
protected void scanDrop(DockEvent event, boolean drop)
protected GeneralPath buildPathForTab(Rectangle bounds)
public void installDocking(DockingDesktop desktop)
basic implementation use a single DragSource, and thus calls desk.installDockableDragSource(dragSource).
installDocking
in interface DockableContainer
public void uninstallDocking(DockingDesktop desktop)
installDocking().
- Specified by:
uninstallDocking
in interface DockableContainer
public DockViewTitleBar getTitleBar()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |