Access Load Status

Demonstrates how to tell what the ArcGISMap's load status is. An ArcGISMap is considered loaded once it has a valid SpatialReference and it has been set to the MapView.

How it works

To access the ArcGISMap's LoadStatus:

  1. Create an ArcGIS map.
  2. Use ArcGISMap.addLoadStatusChangedListener() and ArcGISMap.getNewLoadStatus() to display the load status of the map.
  3. Set the ArcGIS map to the MapView to began loading.

Code

/*
 * Copyright 2017 Esri.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package com.esri.samples.map.access_load_status;

import javafx.application.Application;
import javafx.application.Platform;
import javafx.geometry.Insets;
import javafx.geometry.Pos;
import javafx.scene.Scene;
import javafx.scene.control.Button;
import javafx.scene.control.Label;
import javafx.scene.control.TextArea;
import javafx.scene.layout.StackPane;
import javafx.scene.layout.VBox;
import javafx.stage.Stage;

import com.esri.arcgisruntime.mapping.ArcGISMap;
import com.esri.arcgisruntime.mapping.Basemap;
import com.esri.arcgisruntime.mapping.view.MapView;

public class AccessLoadStatusSample extends Application {

  private MapView mapView;
  private ArcGISMap map;

  @Override
  public void start(Stage stage) throws Exception {

    try {
      // create stack pane and application scene
      StackPane stackPane = new StackPane();
      Scene scene = new Scene(stackPane);
      scene.getStylesheets().add(getClass().getResource("/css/style.css").toExternalForm());

      // set title, size, and add scene to stage
      stage.setTitle("Access Load Status Sample");
      stage.setWidth(800);
      stage.setHeight(700);
      stage.setScene(scene);
      stage.show();

      // create a control panel
      VBox vBoxControl = new VBox(6);
      vBoxControl.setMaxSize(210, 150);
      vBoxControl.getStyleClass().add("panel-region");

      // create area to display load status text
      Label loadStatusLabel = new Label("Load Status");
      loadStatusLabel.getStyleClass().add("panel-label");
      TextArea loadStatusText = new TextArea();
      loadStatusText.setMaxHeight(200);

      Button reloadMapButton = new Button("Reload ArcGISMap");
      reloadMapButton.setMaxWidth(Double.MAX_VALUE);

      // reload ArcGISMap when button clicked
      reloadMapButton.setOnAction(event -> {
        loadStatusText.clear();

        // reload the same ArcGISMap
        map = new ArcGISMap(Basemap.createImagery());

        map.addLoadStatusChangedListener(e -> {
          String loadingStatus;

          // check the loading status
          switch (e.getNewLoadStatus()) {
            case LOADING:
              loadingStatus = "Load Status: LOADING!";
              break;
            case FAILED_TO_LOAD:
              loadingStatus = "Load Status: FAILED TO LOAD!";
              break;
            case NOT_LOADED:
              loadingStatus = "Load Status: NOT LOADED!";
              break;
            case LOADED:
              loadingStatus = "Load Status: LOADED!";
              break;
            default:
              loadingStatus = "Load Status: ERROR!";
          }

          // update the load status text to the loading status that was fired
          Platform.runLater(() -> loadStatusText.appendText(loadingStatus + "\n"));
        });

        mapView.setMap(map);
      });

      // add label, text and button to the control panel
      vBoxControl.getChildren().addAll(loadStatusLabel, loadStatusText, reloadMapButton);

      // create ArcGISMap with the imagery basemap
      map = new ArcGISMap(Basemap.createImagery());

      // create a view for this ArcGISMap and set ArcGISMap to it
      mapView = new MapView();
      mapView.setMap(map);

      // add the map view and control panel to stack pane
      stackPane.getChildren().addAll(mapView, vBoxControl);
      StackPane.setAlignment(vBoxControl, Pos.TOP_LEFT);
      StackPane.setMargin(vBoxControl, new Insets(10, 0, 0, 10));

    } catch (Exception e) {
      // on any error, display the stack trace
      e.printStackTrace();
    }
  }

  /**
   * Stops and releases all resources used in application.
   */
  @Override
  public void stop() throws Exception {

    if (mapView != null) {
      mapView.dispose();
    }
  }

  /**
   * Opens and runs application.
   *
   * @param args arguments passed to this application
   */
  public static void main(String[] args) {

    Application.launch(args);
  }

}


In this topic
  1. How it works
  2. Code