## JavaScript Bean

# dialog

    Object
        |
        +----netscape.samples.widgets.dialog

JSB_CONSTRUCTOR Index

- netscape_samples_widgets_dialogBut

JSB_DESCRIPTOR Index

- netscape.samples.widgets.dialog

JSB_PROPERTY Index

- dialogTitle
- dialogContent
- dialogOK
- dialogX
- dialogY
- dialogW
- dialogH
- dialogBG
- dialogButtons
- dialogSRC

JSB_METHOD Index

- openDialog
- exampleDialog

JSB_ICON Index

- n_s_w_dialog

## JSB_CONSTRUCTORs

##
- netscape_samples_widgets_dialogBut

      function netscape_samples_widgets_dialogBut()

  Creates the dialog buttons and their container layer

## JSB_DESCRIPTORs

##
- netscape.samples.widgets.dialog

  NAME=netscape.samples.widgets.dialog
  DISPLAYNAME=Movable HTML Dialog
  HELP_URL=netscape/samples/widgets/dialog_jsb.html

  Creates a dialog box layer which can contain arbitrary HTML. Encapsulates logic for dragging the layer around, and hiding the OK / CANCEL buttons during dragging operations to optimize drawing performance.

  In addition, the dialog box retains its open / closed state (but not position) upon a resize event.

## JSB_PROPERTYs

##
- dialogTitle

  NAME=dialogTitle
  DISPLAYNAME=dialog Title
  TYPE=string
  DEFAULT_VALUE=Dialog Box

  The title to appear in the dialog box.
  See Also:
    dialogContent

##
- dialogContent

  NAME=dialogContent
  DISPLAYNAME=dialog Content (text/html)
  TYPE=string
  DEFAULT_VALUE=Enter some text or HTML content here...

  Specifies the arbitrary HTML to be displayed inside of the dialog. Form fields and other items inside the content can be accessed via

      abstractDialog.win.con.document.

  See Also:
    dialogTitle

##
- dialogOK

  NAME=dialogOK
  DISPLAYNAME=Function for dialog OK button
  TYPE=string
  DEFAULT_VALUE=//add your function here

  The function to be called when the OK button is pressed.

##
- dialogX

  NAME=dialogX
  DISPLAYNAME=dialog pageX cord (pixels)
  TYPE=number
  DEFAULT_VALUE=window.innerWidth / 3

  The X Position of the dialog (default behavior is to attempt to center the dialog)
  See Also:
    dialogY
  See Also:
    dialogW
  See Also:
    dialogH

##
- dialogY

  NAME=dialogY
  DISPLAYNAME=dialog pageY cord (pixels)
  TYPE=number
  DEFAULT_VALUE=window.innerHeight / 3

  The Y Position of the dialog (default behavior is to attempt to center the dialog)
  See Also:
    dialogX
  See Also:
    dialogW
  See Also:
    dialogH

##
- dialogW

  NAME=dialogW
  DISPLAYNAME=dialog Width (pixels)
  TYPE=number
  DEFAULT_VALUE=null

  The width of the dialog, which by default is determined by the content.
  See Also:
    dialogContent
  See Also:
    dialogH
  See Also:
    dialogX
  See Also:
    dialogY

##
- dialogH

  NAME=dialogH
  DISPLAYNAME=dialog Height (pixels)
  TYPE=number
  DEFAULT_VALUE=null

  The height of the dialog, which by default is determined by the content.
  See Also:
    dialogContent
  See Also:
    dialogW
  See Also:
    dialogX
  See Also:
    dialogY

##
- dialogBG

  NAME=dialogBG
  DISPLAYNAME=dialog bgColor
  TYPE=string
  DEFAULT_VALUE=#CCCCCC

  The background color of the dialog
  See Also:
    dialogContent

##
- dialogButtons

  NAME=dialogButtons
  DISPLAYNAME=display dialog OK/Cancel Buttons
  TYPE=boolean
  DEFAULT_VALUE=true

  A flag to determine if the dialog should display the OK/Cancel buttons

##
- dialogSRC

  NAME=dialogSRC
  DISPLAYNAME=dialog SRC (URL)
  TYPE=string
  DEFAULT_VALUE=URL

## JSB_METHODs

##
- openDialog

  NAME=openDialog
  TYPE=void

  The method to call to open the dialog box.
  Opens the dialog with the currently set parameters (writing the content to the content layer with the mimetype set to "text/html") Form fields and other items inside the content can be accessed via

      abstractDialog.win.con.document.

##
- exampleDialog

  NAME=exampleDialog
  TYPE=void

  The method to call to create a sample dialog box and open it automatically
  This is a sample function which can be called directly to create a simple dialog. Illustrates how to get form-field data from the dialog:

      abstractDialog.win.con.document

  See Also:
    openDialog

## JSB_ICONs

##
- n_s_w_dialog

  NAME=n_s_w_dialog

  n_s_w_ stands for netscape/samples/simple... allows icon to sit in root of jar while providing an (almost) proper namespace.

Generated by jsbdoc on Thu Nov 20 19:16:30 PST 1997