|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ScreenDockWindow
A ScreenDockWindow
is used by a ScreenDockStation
to show
a Dockable
on the screen. Subclasses are free to show the Dockable
in any way they like, however subclasses are encouraged to use a
StationChildHandle
to manage displayers and title.
New implementations of ScreenDockWindow
may require the implementation of a ScreenDockFullscreenStrategy
as well.
Method Summary | |
---|---|
void |
addScreenDockWindowListener(ScreenDockWindowListener listener)
Adds a listener to this window, the listener has to be informed about changes of this window. |
void |
checkWindowBounds()
Ensures the correctness of the boundaries of this window. |
void |
destroy()
Informs this window that it is no longer used by the station and will never be used again. |
Dockable |
getDockable()
Gets the Dockable which is currently shown in this window. |
Insets |
getDockableInsets()
Gets the distances between the edges of the window and the edges of the Dockable . |
Rectangle |
getNormalBounds()
Gets the boundaries this window should use if not in fullscreen mode. |
Point |
getOffsetDrop()
Gets an offset that will be added to the location when dropping a window. |
Point |
getOffsetMove()
Gets an offset that will be subtracted from the location when moving the window around. |
ScreenDockStation |
getStation()
Gets the station which owns this window. |
Rectangle |
getWindowBounds()
Gets the boundaries of the window. |
boolean |
inCombineArea(int x,
int y)
Checks what would happen if a Dockable is dropped at point
x/y . |
boolean |
isFullscreen()
Tells whether this window is in fullscreen mode or not. |
boolean |
isVisible()
Tells whether this window is visible or not. |
void |
removeScreenDockWindowListener(ScreenDockWindowListener listener)
Removes a listener from this window. |
void |
setController(DockController controller)
Sets the controller in whose realm this window will be used. |
void |
setDockable(Dockable dockable)
Sets the Dockable which should be shown on this window. |
void |
setFullscreen(boolean fullscreen)
Changes the mode of this window to fullscreen or to normal. |
void |
setFullscreenStrategy(ScreenDockFullscreenStrategy strategy)
Tells this window what strategy to use for handling fullscreen mode. |
void |
setNormalBounds(Rectangle bounds)
Sets the boundaries this window should use if not in fullscreen mode. |
void |
setPaintCombining(boolean paint)
Sets whether this window should paint some additional markings which indicate that a Dockable is about to be dropped onto it. |
void |
setVisible(boolean visible)
Changes the visibility state of this window. |
void |
setWindowBounds(Rectangle bounds)
Sets the bounds the window is supposed to have. |
void |
toFront()
Called when this window should become the focus owner and be shown at the most prominent location. |
void |
validate()
Forces this window to update the boundaries of its children. |
Method Detail |
---|
void addScreenDockWindowListener(ScreenDockWindowListener listener)
listener
- the new listenervoid removeScreenDockWindowListener(ScreenDockWindowListener listener)
listener
- the listener to removevoid setController(DockController controller)
ScreenDockStation
was set, so AbstractDockStation.getController()
will always
return the same value as controller
. This also implies
that any method of the station called from this method already uses the
new controller.
controller
- the new controller, can be null
ScreenDockStation getStation()
null
void setDockable(Dockable dockable)
Dockable
which should be shown on this window.
dockable
- the new element, can be null
to remove
an old Dockable
Dockable getDockable()
Dockable
which is currently shown in this window.
null
setDockable(Dockable)
void toFront()
void setFullscreenStrategy(ScreenDockFullscreenStrategy strategy)
strategy
- the strategyvoid setFullscreen(boolean fullscreen)
ScreenDockFullscreenStrategy.setFullscreen(ScreenDockWindow, boolean)
,
subclasses may execute additional code.
fullscreen
- the new stateboolean isFullscreen()
ScreenDockFullscreenStrategy.isFullscreen(ScreenDockWindow)
, subclasses
may execute additional checks.
true
if fullscreen mode is activevoid setVisible(boolean visible)
visible
- the new stateboolean isVisible()
void destroy()
void setPaintCombining(boolean paint)
Dockable
is about to be dropped onto it.ScreenDockStation.getPaint()
to get
an algorithm that paints.
paint
- true
if something should be painted,
false
otherwiseRectangle getWindowBounds()
void setWindowBounds(Rectangle bounds)
ScreenDockStation.getBoundaryRestriction()
to check the validity
of the new bounds.
bounds
- the new location and sizevoid setNormalBounds(Rectangle bounds)
ScreenDockFullscreenStrategy
and is usually set to null
if this
window is not in fullscreen mode.
bounds
- the normal bounds, can be null
Rectangle getNormalBounds()
null
void checkWindowBounds()
ScreenDockStation.getBoundaryRestriction()
to do so.
void validate()
Insets getDockableInsets()
Dockable
. This is only an estimate and does not have
to be correct. Implementations using DockableDisplayer
should
call DockableDisplayer.getDockableInsets()
as well.
null
Point getOffsetMove()
DockTitle
of the Dockable
shown in this
window. The value null
can be returned to indicate
that such an offset is not available.
null
Point getOffsetDrop()
null
indicates that no such offset is
available.
null
boolean inCombineArea(int x, int y)
Dockable
is dropped at point
x/y
.
x
- an x coordinate in the screeny
- an y coordinate in the screen
true
if dropping a Dockable
at
x/y
should lead to a combination of the dropped element
and the element in this window, false
otherwise
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |