DOCK Mnemonic - Position the SysWindow (SysConsole/SysWindow)
Syntax
'dock'("direction")
'dock'("direction",offset)
Description
In BBj 2.01 and higher, the 'DOCK' mnemonic will position the edges of the SysConsole/SysWindow along the sides of the display screen according to the specified direction parameter using the specified integer offset.
|
Parameter |
Description |
|
"direction" |
Docking direction from the table below. |
|
offset |
An optional integer offset to be applied to the docking direction. If an offset is not supplied, it defaults to 0. |
CENTER: Moves the SysWindow to the center of the screen. The offset is ignored.
NORTH: Aligns the top edge of the SysWindow with the top of the screen. The offset is applied to the Y position, meaning that the top edge of the SysWindow will be below the top edge of the screen by the number of pixels in the offset.
EAST: Aligns the right edge of the SysWindow with the right side of the screen. The offset is applied to the X position, meaning that the right edge of the SysWindow will be to the left of the right side of the screen by the number of pixels in the offset.
SOUTH: Aligns the bottom edge of the SysWindow with the bottom edge of the screen. The offset is applied to the Y position, meaning that the bottom edge of the SysWindow will be above the bottom edge of the screen by the number of pixels in the offset.
WEST: Aligns the left edge of the SysWindow with the left side of the screen. The offset is applied to the X position, meaning that the left edge of the SysWindow will be to the right of the left side of the screen by the number of pixels in the offset.
NORTHWEST: Matches the upper left corner of the SysWindow with the same corner of the screen. The offset is applied to both the X and Y positions, moving the SysWindow down and right towards the center of the screen.
NORTHEAST: Matches the upper right corner of the SysWindow with the same corner of the screen. The offset is applied to both the X and Y positions, moving the SysWindow down and left towards the center of the screen.
SOUTHWEST: Matches the lower left corner of the SysWindow with the same corner of the screen. The offset is applied to both the X and Y positions, moving the SysWindow up and right towards the center of the screen.
SOUTHEAST: Matches the lower right corner of the SysWindow with the same corner of the screen. The offset is applied to both the X and Y positions, moving the SysWindow up and left towards the center of the screen.
No limit is placed on the range of the offset value, and therefore an extremely large offset could result in the SysConsole/SysWindow being positioned off the screen entirely.
If BBj is running under Java 1.4 or higher, the 'DOCK' mnemonic will take in to consideration any objects in the native windowing system such as menu bars or task bars. If BBj is being run with Java 1.3.x, the 'DOCK' mnemonic will not be able to account for these native objects. The SysWindow will be positioned relative to the extreme dimensions of the screen, and will be shown underneath the native objects.