Class: ResultsDialog

ResultsDialog

new ResultsDialog(config)

A dialog that displays search by area results in table format
Parameters:
Name Type Description
config Object Configuration for this object. The config supplied directly extends the control

Extends

Members

advancedSearch

Properties:
Name Type Description
advancedSearch bool use advanced search features.

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:

collateResults

Properties:
Name Type Description
collateResults bool Return the results in one batch.

dialogControllerId

Properties:
Name Type Description
dialogControllerId string Dialog Controller id.

events

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

feature

Properties:
Name Type Description
feature OpenLayers.Feature.Vector search feature.

featureLayer

Properties:
Name Type Description
featureLayer Openlayers.Layer.Vector layer the search feature is in.

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
Overrides:

id

Properties:
Name Type Description
id string The id for this control
Overrides:

isMobileDevice

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

labels

Properties:
Name Type Description
labels Object object containing label text for the dialog.

layerVisibility

Properties:
Name Type Description
layerVisibility Cadcorp.UI.LayerVisibilityState layer visibility state

(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
Overrides:

(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:
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

prefix

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

preSearchLayerVisibility

Properties:
Name Type Description
preSearchLayerVisibility Cadcorp.UI.LayerVisibilityState visibility object for the pre search map.

queries

Properties:
Name Type Description
queries Array.<Object> object array containing query objects.

searchLayerVisibility

Properties:
Name Type Description
searchLayerVisibility Cadcorp.UI.LayerVisibilityState visibility object for the search layer.

showCount

Properties:
Name Type Description
showCount bool Show the result count.

stayOpen

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

titleText

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

Methods

(protected) afterCloseHandler()

Event handler for the dialogController after close event.
Properties:
Name Type Description
event Object event arguments.

(protected) beforeCloseHandler()

Event handler for the before close event
Properties:
Name Type Description
event Object event arguments.

(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

(protected) dataSelected_handler(eventArgs)

Handles the table being selected from the queryselect control.
Parameters:
Name Type Description
eventArgs Object event arguments

destroy()

Destroys this dialog
Inherited From:

(protected) featuresCounted_handler(eventArgs)

Handles the features counted event from the queryHelper or the query selection control.
Parameters:
Name Type Description
eventArgs Object event arguments

(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) getMoreDataHandler(e)

Triggers the loading of data from the active search.
Parameters:
Name Type Description
e Object event args

(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.
Overrides:

isOpen() → {boolean}

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

(protected) itemPopulated_handler(eventArgs)

Handles the item populated event from the queryHelper or the querySelection control.
Parameters:
Name Type Description
eventArgs Object event arguments

(protected) itemsUpdated_handler(eventArgs)

Handles data returned from query if collate isn't used.
Parameters:
Name Type Description
eventArgs Object

(protected) layerSelected(id)

Handle changes to the overlays from the dataSelected event handler.
Parameters:
Name Type Description
id string Overlay ID property.

(protected) queryComplete_handler(eventArgs)

Handles the query complete event from the queryHelper or the query selection control.
Parameters:
Name Type Description
eventArgs Object event arguments

(protected) queryError_handler(eventArgs)

Handles the query error event from the queryHelper or the query selection control.
Parameters:
Name Type Description
eventArgs Object event arguments

(protected) resizeHandler()

Event handler for the window resize event
Inherited From:

(protected) returnToMap_handler(e)

Handles returning from the print view.
Parameters:
Name Type Description
e Object event args.

(protected) saveTriggered_handler(e)

Event triggred when save button is clicked.
Parameters:
Name Type Description
e Object click event args.

(protected) schemaLoaded_handler(e)

Handles the schema loaded event.
Parameters:
Name Type Description
e type

show()

Hides this dialog.
Overrides:

(protected) showAllClick_handler(e)

Shows all the search results.
Parameters:
Name Type Description
e Object event args

suppressHide_handler(e)

Activates hide suppression mode.
Parameters:
Name Type Description
e Object event args

(protected) zoomButtonClick_handler(e)

Zoom button click handler
Parameters:
Name Type Description
e Object event args

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: