Class: ReportItDialog

Cadcorp.UI.ReportItDialog

new ReportItDialog(config)

Displays the ReportIt dialog.
The dialog is enhanced by using the jQuery UI dialog widget
Parameters:
Name Type Description
config Object Configuration for this object. The config supplied directly extends the control

Extends

Members

alreadyOpen

Properties:
Name Type Description
alreadyOpen boolean If set to true, the dialog is already open
Inherited From:

closeText

Properties:
Name Type Description
closeText string The text added to the close button
Inherited From:

(constant) errorMessages :Object

A map containing error messages
Type:
  • Object

events

Properties:
Name Type Description
events Cadcorp.Util.Events The events object
Inherited From:

footerId

Properties:
Name Type Attributes Description
footerId string <nullable>
 The id of the footer element
Inherited From:

(constant) HEIGHT_SPACER :number

Used to give a constant spacing between the top of a dialog and the top element on the screen
Type:
  • number
Inherited From:

heightFactor

Properties:
Name Type Description
heightFactor number Used when calculating the height of the dialog
Inherited From:

icon

Properties:
Name Type Description
icon Cadcorp.UI.ReportItDialog.Icon The icon to display when a location is marked

id

Properties:
Name Type Description
id string The id for this control
Inherited From:

isMobileDevice

Properties:
Name Type Description
isMobileDevice boolean If set to true, the device this dialog is running on is a mobile device
Inherited From:

loadingReportTypesText

Properties:
Name Type Description
loadingReportTypesText string The text to display while getting the report types

locationButtonConfirmText

Properties:
Name Type Description
locationButtonConfirmText string The text to display on the get location button

(protected) m_content

Properties:
Name Type Description
m_content Object The jquery object that contains the content for this dialog
Inherited From:

(protected) m_dialog

Properties:
Name Type Description
m_dialog Object The jquery object that is this dialog
Inherited From:

(protected) m_errorDialog

Properties:
Name Type Description
m_errorDialog Cadcorp.UI.ErrorDialog The jquery dialog used to display any error for this dialog
Inherited From:
Properties:
Name Type Attributes Description
m_menu Object <nullable>
 The jquery object that is the menu
Inherited From:
Properties:
Name Type Attributes Description
m_menuItem Object <nullable>
 The jquery object that is the menu item
Inherited From:

mapId

Properties:
Name Type Attributes Description
mapId string <nullable>
 The id of the map this dialog is linked to
Inherited From:

(constant) MARKER_GROUP :string

The group identifier for markers placed by this report
Type:
  • string
Properties:
Name Type Attributes Description
menuId string <nullable>
 The id of the menu control
Inherited From:
Properties:
Name Type Attributes Description
menuItemId string <nullable>
 The id of the menu item control this dialog is triggered by
Inherited From:
Properties:
Name Type Description
modal boolean If set to true, the dialog will have modal behavior; other items on the page will be disabled, i.e., cannot be interacted with. Modal dialogs create an overlay below the dialog but above other page elements.
Inherited From:
Default Value:
  • false

name

Properties:
Name Type Description
name string The name of this report

prefix

Properties:
Name Type Description
prefix string The asp.net client id
Inherited From:

problems

Properties:
Name Type Description
problems Array.<Cadcorp.UI.ReportProblem> Array of problems

serviceUrl

Properties:
Name Type Description
serviceUrl Cadcorp.UI.ReportItDialog.Icon The url to the web service

showLocationOptions

Properties:
Name Type Description
showLocationOptions boolean Should the control show the location options

stayOpen

Properties:
Name Type Description
stayOpen boolean If set to true, stops the dialog from closing
Inherited From:

submitText

Properties:
Name Type Description
submitText string The text to display on the submit button

submittingText

Properties:
Name Type Description
submittingText string The text to display while submitting the report

titleText

Properties:
Name Type Description
titleText string The title text for this dialog
Inherited From:

Methods

(protected) calculateInitialWidth() → {number}

Calculates the initial width of the dialog. This can called before create.
Inherited From:
Returns:
The width of the dialog in pixels
Type
number

(protected) calculateMaxHeight() → {number}

Calculates the height of the dialog. If menu and footerId are not null the height of these 2 elements is subtracted from the height so the dialog always fits on the page.
Inherited From:
Returns:
The height of the dialog in pixels
Type
number

(protected) calculateWidth() → {number}

Calculates the width of the dialog. This method should only be called after create has been called.
Inherited From:
Returns:
The width of the dialog in pixels
Type
number

create(userDialogConfig)

Creates the jQuery UI dialog. The userDialogConfig parameter is used to override the default options.
Parameters:
Name Type Description
userDialogConfig Object An object containing options for this dialog. Any valid option for the jQuery Ui Dialog widget can be supplied
Inherited From:

destroy()

Destroys this dialog
Inherited From:

(protected) getBottomPosition() → {Cadcorp.UI.DialogBase.Position}

Calculates the bottom position for this dialog. If footerId is not null the top of the footer is used to calculate the bottom position, otherwise the full height of the page is used.
Inherited From:
Returns:
The bottom left coordinate of this dialog
Type
Cadcorp.UI.DialogBase.Position

(protected) getMenu() → {Cadcorp.UI.Menu}

Gets the menu object, if any, for this dialog
Inherited From:
Returns:
The menu linked to this dialog
Type
Cadcorp.UI.Menu

(protected) getMenuHeight() → {number}

Gets the height of the linked menu in pixels. If menuId is null 0 is returned, otherwise the height of the menu.
Inherited From:
Returns:
The height of the linked menu
Type
number

(protected) getSize() → {Cadcorp.UI.DialogBase.Size}

Gets the current size of this dialog.
Inherited From:
Returns:
The size of the dialog
Type
Cadcorp.UI.DialogBase.Size

(protected) getTopPosition() → {Cadcorp.UI.DialogBase.Position}

Calculates the top position for this dialog. If menuId is not null the bottom of the menu is used to calculate the top position
Inherited From:
Returns:
The top left coordinate of this dialog
Type
Cadcorp.UI.DialogBase.Position

hide()

Hides this dialog.
Inherited From:

isOpen() → {boolean}

Determines if this dialog is open or not.
Inherited From:
Returns:
True if the dialog is open, otherwise false
Type
boolean

(protected) resizeHandler()

Event handler for the window resize event
Inherited From:

show()

Shows this dialog, creating it if required.
Inherited From:

Type Definitions

Icon

An object that represents a icon
Type:
  • Object
Properties:
Name Type Description
file string The url to the image to display
height number The height, in pixels, of the image
width number The width, in pixels, of the image
offsetx number The x offset, in pixels, to apply to the image to position it correctly
offsety number The y offset, in pixels, to apply to the image to position it correctly
id number The unique id of this icon

Events

beforeclose

Before close event
Type:
  • Object
Properties:
Name Type Description
object Cadcorp.UI.DialogBase The sender of the event
Inherited From:

close

Close event
Type:
  • Object
Properties:
Name Type Description
object Cadcorp.UI.DialogBase The sender of the event
Inherited From:

open

Open event
Type:
  • Object
Properties:
Name Type Description
object Cadcorp.UI.DialogBase The sender of the event
Inherited From: