Class: SearchUI

SearchUI

new SearchUI(config)

Manages the Search UI. Can respond to events from a {Cadcorp.UI.SearchByArea.MultiSelectOverlaysModel} using the "observe" method. Use GetUI to get the base DOM element.
Parameters:
Name Type Description
config object Configuration for this object. The config supplied directly extends the control.

Members

(static) content

Properties:
Name Type Description
content object Root DOM node.

(static) errorDialog

Properties:
Name Type Description
errorDialog Cadcorp.UI.ErrorDialog Modal dialog to show error messages.

(static) imageUrls

Properties:
Name Type Description
imageUrls object URLs for the {Cadcorp.UI.SearchByArea.SearchOverlayUI} elements.

(static) labels

Properties:
Name Type Description
labels object Labeltext.

(static) overlayAddedDelegate

Properties:
Name Type Description
overlayAddedDelegate Cadcorp.UI.SearchByArea.OverlayModelDelegate delegate executed when a watched model triggers an overlayadded event.

(static) overlayRemovedDelegate

Properties:
Name Type Description
overlayRemovedDelegate Cadcorp.UI.SearchByArea.OverlayModelDelegate delegate executed when a watched model triggers an overlayremoved event.

(static) overlays

Properties:
Name Type Description
overlays object Root overlays DOM UI element. Hidden when in loading state.

(static) overlayVisibilityChangedDelegate

Properties:
Name Type Description
overlayVisibilityChangedDelegate Cadcorp.UI.SearchByArea.OverlayModelVisibilityDelegate delegate executed when a watched model triggers a visibility change event.

(static) searchOverlays

Properties:
Name Type Description
searchOverlays object Hashmap of {Cadcorp.UI.SearchByArea.SearchOverlayUI} values, mapped by the {Cadcorp.GeognoSIS.Overlay#id} property.

Methods

(static) buildUI()

Builds the DOM UI.

(static) clickHandler(event)

Handle click events fired by {Cadcorp.UI.SearchByArea.SearchOverlayUI}.
Parameters:
Name Type Description
event Cadcorp.UI.SearchByArea.SearchOverlayUI~clickedEvent
Fires:
  • Cadcorp.UI.SearchByArea.SearchUI~event:overlayclickedEvent

(static) destroy()

Safely remove references to other objects and unregister event handlers.

(static) getUI()

Return the root DOM element of this UI class.

(static) loadOverlayFailure()

Show the Failure to Load Overlays error message dialog.

(static) noOverlaysFound()

Show the No Overlays Found error message dialog.

(static) noOverlaysSelected()

Show the No Overlays Selected error message.

(static) observe(model)

Registers delegates on this to a {Cadcorp.UI.SearchByArea.MultiSelectOverlaysModel}.
Parameters:
Name Type Description
model Cadcorp.UI.SearchByArea.MultiSelectOverlaysModel

(static) overlayAddedHandler(event)

The default handler function used for this.overlayAddedDelegate.
Parameters:
Name Type Description
event Cadcorp.UI.SearchByArea~OverlayModelChangeEvent An overlay model changed event.
Fires:
  • Cadcorp.UI.SearchByArea~event:OverlaysUIBuilt

(static) overlayRemovedHandler(event)

Handle {Cadcorp.UI.SearchByArea.OverlaysModel~overlayremoved} events.
Parameters:
Name Type Description
event Cadcorp.UI.SearchByArea.OverlaysModel~overlayremoved The overlayremoved event.

(static) registerOverlayClickedHandler(delegate)

Register a {Cadcorp.UI.SearchByArea.SearchUI.OverlayClickedCallback}.
Parameters:
Name Type Description
delegate Cadcorp.UI.SearchByArea.SearchUI.OverlayClickedCallback

(static) registerOverlaysUIBuiltHandler(delegate)

Register a delegate to listen to {Cadcorp.UI.SearchByArea.SearchUI~overlaysUIBuiltEvent}.
Parameters:
Name Type Description
delegate Cadcorp.UI.SearchByArea.SearchUI.OverlaysUIBuiltCallback

(static) showOverlaysLoading()

Display the loading GIF in place of the overlay list.

(static) stopOverlaysLoading()

Hide the loading GIF and show the overlay list.

(static) unregisterOverlayClickedHandler(delegate)

Unregister a {Cadcorp.UI.SearchByArea.SearchUI.OverlayClickedCallback}.
Parameters:
Name Type Description
delegate Cadcorp.UI.SearchByArea.SearchUI.OverlayClickedCallback

(static) unregisterOverlaysUIBuiltHandler(delegate)

Unregister an {Cadcorp.UI.SearchByArea.SearchUI.OverlaysUIBuiltCallback}.
Parameters:
Name Type Description
delegate Cadcorp.UI.SearchByArea.SearchUI.OverlaysUIBuiltCallback

(static) visibilityChangedHandler(event)

The default handler function used for this.overlayVisibilityChangedDelegate.
Parameters:
Name Type Description
event Cadcorp.UI.SearchByArea~VisibilityChangedEvent A visibility changed event.

Type Definitions

OverlayClickedCallback()

Handle the searchoverlayclicked event.
Parameters:
Type Description
Cadcorp.UI.SearchByArea.SearchOverlayUI~searchoverlayclicked