Package uk.ac.rdg.resc.godiva.client

Class Godiva

    • Field Detail

      • infoButton

        protected com.google.gwt.user.client.ui.PushButton infoButton

      • logo

        protected com.google.gwt.user.client.ui.Image logo

      • loadingImage

        protected com.google.gwt.user.client.ui.Image loadingImage

      • permalinking

        protected boolean permalinking

      • kmzLink

        protected com.google.gwt.user.client.ui.Anchor kmzLink

      • permalink

        protected com.google.gwt.user.client.ui.Anchor permalink

      • email

        protected com.google.gwt.user.client.ui.Anchor email

      • screenshot

        protected com.google.gwt.user.client.ui.Anchor screenshot

      • docLink

        protected com.google.gwt.user.client.ui.Anchor docLink

      • queryable

        protected boolean queryable

      • downloadable

        protected boolean downloadable

      • timeseriesSupported

        protected boolean timeseriesSupported

      • profilesSupported

        protected boolean profilesSupported

      • currentLayerExtent

        protected String currentLayerExtent

      • zoomToLayerExtents

        protected com.google.gwt.user.client.ui.PushButton zoomToLayerExtents

    • Constructor Detail

      • Godiva

        public Godiva()

    • Method Detail

      • init

        protected void init()
        Description copied from class: BaseWmsClient
        This gets called once the page has loaded. Subclasses should use for initializing any widgets, and setting the layout. If this is not implemented, a blank page will be displayed
        Specified by:
        init in class BaseWmsClient

      • requestAndPopulateMenu

        protected void requestAndPopulateMenu()
        Requests the layer menu from the server. When the menu is returned, menuLoaded will be called
        Specified by:
        requestAndPopulateMenu in class BaseWmsClient

      • availableTimesLoaded

        protected void availableTimesLoaded​(String layerId,
                                    List<String> availableTimes,
                                    String nearestTime)
        Description copied from class: BaseWmsClient
        This is called once a list of available times has been loaded
        Specified by:
        availableTimesLoaded in class BaseWmsClient
        Parameters:
        layerId - the layer for which times have been loaded
        availableTimes - a List of available times
        nearestTime - the nearest time to the current time (for e.g. auto selection)

      • updateMap

        protected void updateMap​(MapArea mapArea,
                         String layerUpdated)
        Description copied from class: BaseWmsClient
        This is where the map should be updated. It gets called when all details have been loaded and we actually want to update the map. Clients should handle this in the appropriate way, which will almost certainly involve a call to mapArea.addLayer(...)
        Specified by:
        updateMap in class BaseWmsClient
        Parameters:
        mapArea - The map area which can be updated
        layerUpdated - The ID of the layer which we are viewing

      • loadingFinished

        protected void loadingFinished()
        Description copied from class: BaseWmsClient
        This is called when all loading processes have finished
        Specified by:
        loadingFinished in class BaseWmsClient

      • getCurrentTime

        protected String getCurrentTime()
        Description copied from class: BaseWmsClient
        Returns the "current" time. The definition of current may depend on exactly what the client does. This is the time used when requesting layer details from the server - i.e. the time to which the "nearestTime" will refer
        Specified by:
        getCurrentTime in class BaseWmsClient
        Returns:
        A string representation of the current time

      • enableWidgets

        public void enableWidgets()
        Description copied from interface: GodivaActionsHandler
        Called to enable widgets. This allows control of which widgets are available when e.g. animation is happening
        Specified by:
        enableWidgets in interface GodivaActionsHandler

      • disableWidgets

        public void disableWidgets()
        Description copied from interface: GodivaActionsHandler
        Called to disable widgets. This allows control of which widgets are available when e.g. animation is happening
        Specified by:
        disableWidgets in interface GodivaActionsHandler

      • getAviUrl

        public String getAviUrl​(String times,
                        String frameRate)
        Description copied from interface: AviExportHandler
        Returns the URL to fetch an AVI file. This depends on the timesteps and frame rate required (all other data can be obtained from the current state (GodivaStateInfo)
        Specified by:
        getAviUrl in interface AviExportHandler
        Parameters:
        times - A string representing the desired times
        frameRate - The frame rate, in frames-per-second
        Returns:
        A URL which will lead to an AVI file containing an animation

      • animationStarted

        public void animationStarted​(String times,
                             String fps)
        Description copied from interface: AviExportHandler
        This is called when an animation is started. We provide the times and FPS so that the implementation can call getAviUrl if required (for example to set a link to the AVI when an animation is started as an overlay)
        Specified by:
        animationStarted in interface AviExportHandler

      • setOpacity

        public void setOpacity​(String layerId,
                       float opacity)
        Description copied from interface: PaletteSelectionHandler
        Called when the opacity of a layer is set
        Specified by:
        setOpacity in interface PaletteSelectionHandler
        Parameters:
        layerId - The layer to set the opacity of
        opacity - The opacity as a float ranging from 0-1

      • layerDetailsLoaded

        protected void layerDetailsLoaded​(LayerDetails layerDetails)
        Description copied from class: BaseWmsClient
        This is called once a layer's details have been loaded. By default this will just populate the widgets associated with this layer, but subclasses may want to override this method to implement custom behaviour before/after populating the widgets
        Overrides:
        layerDetailsLoaded in class BaseWmsClient
        Parameters:
        layerDetails - the details received from the server

      • onMapMove

        public void onMapMove​(org.gwtopenmaps.openlayers.client.event.MapMoveListener.MapMoveEvent eventObject)
        Specified by:
        onMapMove in interface org.gwtopenmaps.openlayers.client.event.MapMoveListener
        Overrides:
        onMapMove in class BaseWmsClient

      • onMapZoom

        public void onMapZoom​(org.gwtopenmaps.openlayers.client.event.MapZoomListener.MapZoomEvent eventObject)
        Specified by:
        onMapZoom in interface org.gwtopenmaps.openlayers.client.event.MapZoomListener
        Overrides:
        onMapZoom in class BaseWmsClient

      • requestLayerDetails

        protected void requestLayerDetails​(String wmsUrl,
                                   String layerId,
                                   String currentTime,
                                   boolean autoZoomAndPalette)
        Description copied from class: BaseWmsClient
        Request details about a particular layer. Once loaded, layerDetailsLoaded will be called.
        Overrides:
        requestLayerDetails in class BaseWmsClient
        Parameters:
        wmsUrl - the base URL of the WMS server containing the layer details
        layerId - the ID of the layer whose details are desired
        currentTime - the time we want to know the closest available time to. Can be null
        autoZoomAndPalette - true if we want to zoom to extents and possibly auto-adjust palette once the details have been loaded. Note that this will only auto-adjust the palette if the conditions are right

      • setUnitConverter

        protected void setUnitConverter​(UnitConverter converter)
        Overrides the parent method using the single-WMS layer. Subclasses should use this to set a UnitConverter
        Parameters:
        converter - The UnitConverter to use for the WMS layer

      • menuLoaded

        protected void menuLoaded​(LayerMenuItem menuTree)

      • getLogo

        protected com.google.gwt.user.client.ui.Image getLogo()
        This is something that will almost certainly be changed for custom clients, so put it in a method which can be overridden

      • getTimeSelector

        protected TimeSelectorIF getTimeSelector()
        Gets a new time selector. This method is used in the construction of the Godiva interface and is only called once.
        Returns:
        A new instance of a TimeSelectorIF

      • getElevationSelector

        protected ElevationSelectorIF getElevationSelector()
        Gets a new elevation selector. This method is used in the construction of the Godiva interface and is only called once.
        Returns:
        A new instance of an ElevationSelectorIF

      • getLayerSelector

        protected LayerSelectorIF getLayerSelector()
        Gets a new layer selector. This method is used in the construction of the Godiva interface and is only called once.
        Returns:
        A new instance of a LayerSelectorIF

      • getLayout

        protected com.google.gwt.user.client.ui.Widget getLayout()
        Gets the layout. This should return a top-level object which contains the entire page, since this is what gets added to the main window as the layout