public interface IContour
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 guarantee the class will remain as it is.Modifier and Type | Method and Description |
---|---|
void |
cleanup() |
java.awt.Component |
getAttachedComponent()
Gets the attached component of this contour.
|
int |
getAttachedSide()
Gets the side of the attached component which the contour is attached to.
|
java.awt.Rectangle |
getBounds() |
java.awt.Component |
getGlassPane() |
java.awt.Container |
getRelativeContainer() |
javax.swing.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 allowed.
|
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 |
setAllowDocking(boolean allowDocking)
Sets the value of docking.
|
void |
setAttachedComponent(java.awt.Component attachedComponent)
Sets the attached components.
|
void |
setAttachedSide(int attachedSide)
Sets the side of the attached component which the contour is attached to.
|
void |
setBounds(int x,
int y,
int width,
int height) |
void |
setBounds(java.awt.Rectangle r) |
void |
setChangeCursor(boolean changeCursor) |
void |
setDraggingInformation(javax.swing.JComponent comp,
int saveX,
int saveY,
int saveMouseModifier)
Stores information before the contour is hidden.
|
void |
setFloating(boolean floating)
Sets the floating mode.
|
void |
setGlassPane(java.awt.Component glassPane) |
void |
setRelativeContainer(java.awt.Container relativeContainer) |
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.
|
java.awt.Rectangle getBounds()
boolean isLightweight()
void setBounds(java.awt.Rectangle r)
void setBounds(int x, int y, int width, int height)
int getTabHeight()
void setTabHeight(int tabHeight)
tabHeight
- boolean isTabDocking()
void setTabDocking(boolean tabDocking)
tabDocking
- new modeint getTabSide()
void setTabSide(int tabSide)
tabSide
- boolean isFloating()
void setFloating(boolean floating)
floating
- new modejava.awt.Component getAttachedComponent()
void setAttachedComponent(java.awt.Component attachedComponent)
attachedComponent
- attached component to be setint getAttachedSide()
void setAttachedSide(int attachedSide)
attachedSide
- the new attached side to be setboolean isSingle()
true
if all dragged components are affected; false
otherwise.void setSingle(boolean single)
single
- true
if all dragged components are affected; false
otherwise.boolean isAllowDocking()
true
if docking is allowed; false
otherwise.void setAllowDocking(boolean allowDocking)
allowDocking
- true
if docking is allowed; false
otherwise.java.awt.Container getRelativeContainer()
void setRelativeContainer(java.awt.Container relativeContainer)
int getSaveX()
int getSaveY()
int getSaveMouseModifier()
javax.swing.JComponent getSaveDraggedComponent()
void setDraggingInformation(javax.swing.JComponent comp, int saveX, int saveY, int saveMouseModifier)
comp
- the dragged componentsaveX
- X position of the contoursaveY
- Y position of the contoursaveMouseModifier
- mouse modifier in the MouseEventvoid cleanup()
void setVisible(boolean aFlag)
Component.setVisible
.aFlag
- true to make the component visible; false to make it invisibleboolean isVisible()
Frame
objects.true
if the component is visible, false
otherwisesetVisible(boolean)
void setGlassPane(java.awt.Component glassPane)
java.awt.Component getGlassPane()
void setChangeCursor(boolean changeCursor)