Class dBox

Object
   |
   +--dBox

class dBox

This is the basic dBox class.
Defined in dbox.js

Field Detail

anchor

Object anchor

area

Object area

areaHandler

Object areaHandler

box

Object box

busyImage

Object busyImage

busyMessage

Object busyMessage

canvas

Object canvas

color

String color

color (either name or hexidecimal) of any drawing elements. (default: red)

container

Object container

cursor

String cursor

cursor to be displayed when over the dBox. (default: crosshair).

drag

Object drag

dragging

Object dragging

height

Object height

image

Object image

jitter

Integer jitter

minimum size (in pixels_ of a mouse event resulting in a point. (default: 10).

length

Object length

line

Object line

measureHandler

Object measureHandler

mouseEnterHandler

Function mouseEnterHandler

function to be called on mouse enter events.

Must be defined and set (via setHandler()) elsewhere in the application, or nothing happens with these events.

mouseExitHandler

Object mouseExitHandler

mouseMoveHandler

Object mouseMoveHandler

name

Object name

offsetx

Object offsetx

poly

Object poly

resetHandler

Object resetHandler

setBoxHandler

Object setBoxHandler

thickness

Integer thickness

thickness (in pixels) of lines for any drawing elements. (default: 1)

verbose

Object verbose

waiting

Object waiting

width

Object width

x

Object x

x1

Object x1

y

Object y

dBox

dBox(<String> name)

Construct a new dBox object.

Parameters:
name - The name of the anchor element (img or div).

Returns:
A new mapserv object

boxOff

void boxOff()

Turn box dragging off.

boxOn

void boxOn()

Turn box dragging on.

busyOff

void busyOff()

Method to turn off busy image/message. It gets called after the image has loaded.

busyOn

void busyOn()

Method that controls the style of the busy message. This can be overridden. When the busy message/image is displayed a disaabled zone is placed over the entire page, essentially preeeventing a users interaction with the page during the loading process.

dragOff

void dragOff()

Turn drag panning off.

dragOn

void dragOn()

Turn drag panning on.

initialize

void initialize()

Method to initialize dBox. This should be called after page load.

lineOff

void lineOff()

Turn line drawing off.

lineOn

void lineOn()

Turn line drawing on.

mouseDown

void mouseDown(event)

mouseDrag

void mouseDrag(event)

mouseEnter

void mouseEnter(event)

mouseExit

void mouseExit(event)

mouseMove

void mouseMove(event)

mouseUp

void mouseUp(event)

paint

void paint()

polyOff

void polyOff()

Turn polygon drawing off.

polyOn

void polyOn()

Turn polygon drawing on.

reset

void reset()

setHandler

void setHandler(<Enumerated> type, <Function> handler)

set a handler function for draw/query operations.

Parameters:
type - constant for handler type to be set. Valid type values are:
• DBOX_MOUSEENTER (0)
• DBOX_MOUSEEXIT (1)
• DBOX_MOUSEMOVE (2)
• DBOX_SETBOX (3)
• DBOX_MEASURE (5)
• DBOX_AREA (6)
handler - function to be called

setImage

void setImage(<String> url)

Change the image displayed in the dBox object.

Parameters:
url - for the new image

sync

void sync()

Reposition the dBox object relative to the anchor.

useBusyMessage

void useBusyMessage(obj)

Method will cause dbox to display a busy message during the onload event handler of the main image. This method can be called in one of three ways: 1) e.g., "Loading" will display a "Google"-style red box in the upper right corner of the page. 2) e.g., Create an Image with the height, width and src properties set. The image will display in the center of the main image. 3) e.g., Calling this method with anything else will use a busy image using the default image set in the following global variables: DEFAULT_BUSY_LOADING_IMG_SRC, DEFAULT_BUSY_LOADING_WIDTH, DEFAULT_BUSY_LOADING_HEIGHT.