File : dialogs/osmSearchDialog/OsmSearchDialog.js

/*

Copyright - 2017 2023 - wwwouaiebe - Contact: https://www.ouaie.be/

This  program is free software;

you can redistribute it and/or modify it under the terms of the

GNU General Public License as published by the Free Software Foundation;

either version 3 of the License, or any later version.

This program is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

GNU General Public License for more details.

You should have received a copy of the GNU General Public License

along with this program; if not, write to the Free Software

Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

*/

/*

Changes:

    - v4.0.0:

        - created from v3.6.0

Doc reviewed 202208

 */

import theConfig from '../../data/Config.js';

import theTranslator from '../../core/uiLib/Translator.js';

import DockableBaseDialog from '../baseDialog/DockableBaseDialog.js';

import theHTMLElementsFactory from '../../core/uiLib/HTMLElementsFactory.js';

import OsmSearchToolbarButtons from './osmSearchToolbarButtons/OsmSearchToolbarButtons.js';

import OsmSearchTree from './osmSearchToolbarTree/OsmSearchTree.js';

import OsmSearchWait from './osmSearchToolbarWait/OsmSearchWait.js';

import OsmSearchContextMenu from '../../contextMenus/OsmSearchContextMenu.js';

import SortableListControl from '../../controls/sortableListControl/SortableListControl.js';

import OsmSearchResultsHTMLBuilder from './osmSearchResults/OsmSearchResultsHTMLBuilder.js';

import OsmSearchLimits from './OsmSearchLimits.js';

import SearchResultMouseEnterEL from './osmSearchResults/SearchResultMouseEnterEL.js';

import SearchResultMouseLeaveEL from './osmSearchResults/SearchResultMouseLeaveEL.js';

import theTravelNotesData from '../../data/TravelNotesData.js';

/* ------------------------------------------------------------------------------------------------------------------------- */

/**

This class is the TravelPropertiesDialog

*/

/* ------------------------------------------------------------------------------------------------------------------------- */

class OsmSearchDialog extends DockableBaseDialog {

    /**

    The limits of the search

    @type {OsmSearchLimits}

    */

    #osmSearchLimits;

    /**

    The toolbar HTMLElement

    @type {HTMLElement}

    */

    #toolbarHTMLElement;

    /**

    The notes control

    @type {SortableListControl}

    */

    #osmSearchResultsControl;

    /**

    The search tree

    @type {OsmSearchTree}

    */

    #osmSearchTree;

    /**

    The wait bar

    @type {OsmSearchWait}

    */

    #osmSearchWait;

    /**

    The html builder for the results

    @type {OsmSearchResultsHTMLBuilder}

    */

    #osmSearchResultsHTMLBuilder;

    /**

    Search result  mouseenter event listener

    @type {SearchResultMouseEnterEL}

    */

    #searchResultMouseEnterEL;

    /**

    Search result contextmenu event listener

    @type {SearchResultMouseLeaveEL}

    */

    #searchResultMouseLeaveEL;

    /**

    Toolbar creation

    */

    #createToolbar ( ) {

        this.#toolbarHTMLElement = theHTMLElementsFactory.create ( 'div' );

        this.#osmSearchTree = new OsmSearchTree ( );

        this.#osmSearchWait = new OsmSearchWait ( );

        const osmSearchToolbarButtons = new OsmSearchToolbarButtons ( this.#osmSearchTree, this.#osmSearchWait );

        this.#toolbarHTMLElement.appendChild ( osmSearchToolbarButtons.toolbarButtonsHTMLElement );

        this.#toolbarHTMLElement.appendChild ( this.#osmSearchTree.treeHTMLElement );

        this.#toolbarHTMLElement.appendChild ( this.#osmSearchWait.waitHTMLElement );

    }

    /**

    The constructor

    */

    constructor ( ) {

        super ( theConfig.osmSearchDialog.dialogX, theConfig.osmSearchDialog.dialogY );

    }

    /**

    Create all the controls needed for the dialog.

    Overload of the base class createContentHTML

    */

    createContentHTML ( ) {

        this.#createToolbar ( );

        this.#osmSearchResultsControl = new SortableListControl (

            null,

            OsmSearchContextMenu

        );

        this.#osmSearchResultsHTMLBuilder = new OsmSearchResultsHTMLBuilder ( );

        this.#osmSearchLimits = new OsmSearchLimits ( );

        this.#searchResultMouseEnterEL = new SearchResultMouseEnterEL ( );

        this.#searchResultMouseLeaveEL = new SearchResultMouseLeaveEL ( );

    }

    /**

    An array with the HTMLElements that have to be added in the content of the dialog.

    Overload of the BaseDialog contentHTMLElements property.

    @type {Array.<HTMLElement>}

    */

    get contentHTMLElements ( ) {

        return [ ].concat (

            this.#osmSearchResultsControl.controlHTMLElement

        );

    }

    /**

    The dialog title. Overload of the BaseDialog.title property

    @type {String}

    */

    get title ( ) { return theTranslator.getText ( 'OsmSearchDialog - Searching OpenStreetMap' ); }

    /**

    The toolbar HTMLElement

    @type {HTMLElement}

    */

    get toolbarHTMLElement ( ) {

        return this.#toolbarHTMLElement;

    }

    /**

    Hide the dialog and the search limits

    */

    onCancel ( ) {

        this.#osmSearchLimits.hide ( );

        super.onCancel ( );

    }

    /**

    Show the dialog and the search limits

    */

    show ( ) {

        super.show ( );

        this.#osmSearchLimits.show ( );

    }

    /**

    Update the content of the dialog

    */

    updateContent ( ) {

        this.#osmSearchWait.hideWait ( );

        this.#osmSearchLimits.hide ( );

        this.#osmSearchLimits.show ( );

        const searchResultsHTMLElements = [];

        theTravelNotesData.searchData.forEach (

            ( osmElement, index ) => {

                const searchResultsHTMLElement = this.#osmSearchResultsHTMLBuilder.buildHTMLElement ( osmElement, index );

                searchResultsHTMLElement.addEventListener ( 'mouseenter', this.#searchResultMouseEnterEL, false );

                searchResultsHTMLElement.addEventListener ( 'mouseleave', this.#searchResultMouseLeaveEL, false );

                searchResultsHTMLElements.push ( searchResultsHTMLElement );

            }

        );

        this.#osmSearchResultsControl.updateContent ( searchResultsHTMLElements );

    }

}

export default OsmSearchDialog;

/* --- End of file --------------------------------------------------------------------------------------------------------- */