com.jidesoft.docking
Interface DockingFrameworkContour

public interface DockingFrameworkContour

A Contour is a lightweight component which only paints the outline of component when dragged. It is also used as a placeholder for some information during dragging.

Usually Contour is added to JLayeredPane of a RootPaneContainer so that it looks like floating above other windows.

Notes: this class has to be public so that JIDE can use it in different packages, not meant to release to end user as a public API. JIDE will not gurantee the class will remain as it is.

Method Summary

void	beginDraggingFrame(JComponent f, int mouseX, int mouseY, double relativeX, double relativeY, boolean single)
Rectangle	calculateContourBounds(Rectangle frameBounds, Component f)
Rectangle	calculateContourBounds(Rectangle frameBounds, int mouseX, int mouseY)
void	cancelDragFrame()
void	cleanup()
void	dragFrame(JComponent comp, int newX, int newY, int mouseModifier) Stores information before the contour is hidden.
Component	getAttachedComponent() Gets the attached component of this contour.
DockingManager	getAttachedDockingManager() Gets the attached DockingManager of this contour.
int	getAttachedSide() Gets the side of the attached component which the contour is attached to.
Rectangle	getContourBounds()
DockingManager	getDockingManager()
Component	getGlassPane()
JLayeredPane	getLayeredPane()
Container	getRelativeContainer()
JComponent	getSaveDraggedComponent() Gets saved dragged component before the contour is hidden.
int	getSaveMouseModifier() Gets saved mouse modifier before the contour is hidden.
int	getSaveX() Gets saved X position of contour before it's hidden.
int	getSaveY() Gets saved Y position of contour before it's hidden.
int	getTabHeight()
int	getTabSide() Gets the side of the tab.
boolean	isAllowDocking() Checks if docking is alloed.
boolean	isFloating() Returns true if the contour is in floating mode.
boolean	isLightweight()
boolean	isSingle() When you dragged a component, several other components could be dragged.
boolean	isTabDocking() Returns true if the contour is in tab-dock mode.
boolean	isVisible() Determines whether this component should be visible when its parent is visible.
void	pauseDragFrame()
void	setAllowDocking(boolean allowDocking) Sets the value of docking.
void	setAttachedComponent(Component attachedComponent) Sets the attached component.
void	setAttachedDockingManager(DockingManager attachedDockingManager) Sets the attached DockingManager.
void	setAttachedSide(int attachedSide) Sets the side of the attached component which the contour is attached to.
void	setChangeCursor(boolean changeCursor)
void	setContourBounds(Rectangle r)
void	setDockingManager(DockingManager dockingManager)
void	setFloating(boolean floating) Sets the floating mode.
void	setGlassPane(Component glassPane)
void	setRelativeContainer(Container relativeContainer)
void	setRelativeXY(double x, double y)
void	setRootPaneContainer(RootPaneContainer rootPaneContainer)
void	setSingle(boolean single) Sets the value of single.
void	setTabDocking(boolean tabDocking) Sets the tab-docking mode.
void	setTabHeight(int tabHeight) Sets the tab height.
void	setTabSide(int tabSide) Sets the side of the tab.
void	setVisible(boolean aFlag) Makes the component visible or invisible.

Method Detail

getContourBounds

Rectangle getContourBounds()

setContourBounds

void setContourBounds(Rectangle r)

isLightweight

boolean isLightweight()

getTabHeight

int getTabHeight()

setTabHeight

void setTabHeight(int tabHeight)

Sets the tab height.

Parameters:

tabHeight -

isTabDocking

boolean isTabDocking()

Returns true if the contour is in tab-dock mode.

Returns:

true if tab-docking; false otherwise

setTabDocking

void setTabDocking(boolean tabDocking)

Sets the tab-docking mode.

Parameters:

tabDocking - new mode

getTabSide

int getTabSide()

Gets the side of the tab.

Returns:

the side of the tab

setTabSide

void setTabSide(int tabSide)

Sets the side of the tab.

Parameters:

tabSide -

isFloating

boolean isFloating()

Returns true if the contour is in floating mode.

Returns:

true if floating; false otherwise

setFloating

void setFloating(boolean floating)

Sets the floating mode.

Parameters:

floating - new mode

getAttachedComponent

Component getAttachedComponent()

Gets the attached component of this contour.

Returns:

the attached component

setAttachedComponent

void setAttachedComponent(Component attachedComponent)

Sets the attached component.

Parameters:

attachedComponent - attached component to be set

getAttachedDockingManager

DockingManager getAttachedDockingManager()

Gets the attached DockingManager of this contour.

Returns:

the attached DockingManager

setAttachedDockingManager

void setAttachedDockingManager(DockingManager attachedDockingManager)

Sets the attached DockingManager.

Parameters:

attachedDockingManager - attached DockingManager to be set

getAttachedSide

int getAttachedSide()

Gets the side of the attached component which the contour is attached to.

Returns:

side the attached side

setAttachedSide

void setAttachedSide(int attachedSide)

Sets the side of the attached component which the contour is attached to.

Parameters:

attachedSide - the new attached side to be set

isSingle

boolean isSingle()

When you dragged a component, several other components could be dragged. For example, if user drags on title bar of FrameContainer, all components in the FrameContainer are considered as dragged. If user drags on tab, only selected one is dragged.

Returns:

true if all dragged components are affected; false otherwise.

setSingle

void setSingle(boolean single)

Sets the value of single.

Parameters:

single - true if all dragged components are affected; false otherwise.

isAllowDocking

boolean isAllowDocking()

Checks if docking is alloed.

Returns:

true if docking is allowed; false otherwise.

setAllowDocking

void setAllowDocking(boolean allowDocking)

Sets the value of docking.

Parameters:

allowDocking - true if docking is allowed; false otherwise.

getRelativeContainer

Container getRelativeContainer()

setRelativeContainer

void setRelativeContainer(Container relativeContainer)

getSaveX

int getSaveX()

Gets saved X position of contour before it's hidden.

Returns:

saved X position

getSaveY

int getSaveY()

Gets saved Y position of contour before it's hidden.

Returns:

saved Y position

getSaveMouseModifier

int getSaveMouseModifier()

Gets saved mouse modifier before the contour is hidden.

Returns:

saved mouse modifier

getSaveDraggedComponent

JComponent getSaveDraggedComponent()

Gets saved dragged component before the contour is hidden.

Returns:

saved dragged component

beginDraggingFrame

void beginDraggingFrame(JComponent f,
                        int mouseX,
                        int mouseY,
                        double relativeX,
                        double relativeY,
                        boolean single)

dragFrame

void dragFrame(JComponent comp,
               int newX,
               int newY,
               int mouseModifier)

Stores information before the contour is hidden. Those information will be used to restore when the contour is set visible again.

Parameters:

comp - the dragged component

newX - X position of the contour

newY - Y position of the contour

mouseModifier - mouse modifier in the MouseEvent

pauseDragFrame

void pauseDragFrame()

cancelDragFrame

void cancelDragFrame()

cleanup

void cleanup()

setVisible

void setVisible(boolean aFlag)

Makes the component visible or invisible. Overrides Component.setVisible.

Parameters:

aFlag - true to make the component visible; false to make it invisible

isVisible

boolean isVisible()

Determines whether this component should be visible when its parent is visible. Components are initially visible, with the exception of top level components such as Frame objects.

Returns:

true if the component is visible, false otherwise

Since:

JDK1.0

See Also:

setVisible(boolean)

setGlassPane

void setGlassPane(Component glassPane)

getGlassPane

Component getGlassPane()

setRootPaneContainer

void setRootPaneContainer(RootPaneContainer rootPaneContainer)

setChangeCursor

void setChangeCursor(boolean changeCursor)

setRelativeXY

void setRelativeXY(double x,
                   double y)

calculateContourBounds

Rectangle calculateContourBounds(Rectangle frameBounds,
                                 int mouseX,
                                 int mouseY)

calculateContourBounds

Rectangle calculateContourBounds(Rectangle frameBounds,
                                 Component f)

getDockingManager

DockingManager getDockingManager()

setDockingManager

void setDockingManager(DockingManager dockingManager)

getLayeredPane

JLayeredPane getLayeredPane()