Class: SearchUIBase

Cadcorp.UI.SearchUIBase

new SearchUIBase(config)

Base class for displaying the results of a search, used for creating subclasses and not instantiated.
Parameters:
Name Type Description
config Object Configuration for this object. The config supplied directly extends the control

Members

(static, readonly) epsgCode

Properties:
Name Type Description
epsgCode number The CRS the result coordinates are in

(static) errorText

Properties:
Name Type Description
nothingFoundText string The text to display in the event of an error

(static) events

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

(static) loadingImageUrl

Properties:
Name Type Description
loadingImageUrl string The url to the loading image

(static) moreDataText

Properties:
Name Type Description
moreDataText string The text to display if more data is available

(static) nothingFoundText

Properties:
Name Type Description
nothingFoundText string The text to display if no results are found

(static) search

Properties:
Name Type Description
search Cadcorp.UI.SearchBase The search this UI will render results for

(static) searchingText

Properties:
Name Type Description
searchingText string The text to display while a search is performed

(static) selectedCssClass

Properties:
Name Type Description
selectedCssClass string The css class to use for selected items

(static) usejQueryUI

Properties:
Name Type Description
usejQueryUI boolean True to use jQuery UI otherwise false

(static, readonly) zoomResolution

Properties:
Name Type Attributes Description
zoomResolution number <nullable>
 The resolution to zoom to when a result is selected

(static, readonly) zoomScale

Properties:
Name Type Attributes Description
zoomScale number <nullable>
 The scale to zoom to when a result is selected

Methods

(protected, static) addResultsRow()

Adds a row to the results table

(static) clear()

Clears the search results

(static) findColumn(dataRow, columnToFind) → {Object|null}

Finds a result column in a row
Parameters:
Name Type Description
dataRow Object
columnToFind string The name of the column to find
Returns:
The found column or null
Type
Object | null

(static) getEasting(data) → {number}

Gets the x coordinate from the supplied data object
Parameters:
Name Type Description
data object Object that contains the data
Returns:
Type
number

(static) getNorthing(data) → {number}

Gets the y coordinate from the supplied data object
Parameters:
Name Type Description
data object Object that contains the data
Returns:
Type
number

(static) getResult(data) → {string}

Gets the result text from the supplied data object
Parameters:
Name Type Description
data object Object that contains the data
Returns:
Type
string

(static) getRowCount() → {number}

Gets the number of rows in the table
Returns:
Type
number

(static) getUI() → {Object}

Gets the UI
Returns:
A jQuery object that contains this info box
Type
Object

(static) removeAllRows()

Removes all rows in the table

(protected, static) rowSelected()

Event handler for row selected

Events

moredatarequired

More data required
Type:
  • Object
Properties:
Name Type Description
sender Cadcorp.UI.SearchUIBase The sender of the event
currentRowCount number The start index for the search

renderednewresults

Results have been rendered
Type:
  • Object
Properties:
Name Type Description
sender Cadcorp.UI.SearchUIBase The sender of the event

rowselected

A result row has been selected
Type:
  • Object
Properties:
Name Type Description
object Cadcorp.UI.SearchUIBase The sender of the event
eventArgs Object jQuery event object