Nädal 8

Sündmused.

Sissejuhatus

Eelmisel nädalal olid vaatluse all graafika ja graafilise kasutajaliidese võimalused. On muidugi selge, et näiteks nupud, millele vajutamisel midagi ei juhtu, on üsna kasutud. Käesoleval nädalal ongi teemaks võimalused, kuidas programmi kasutaja tegevustele reageerima panna. Materjali esimeses osas on sissejuhatus koos väiksemate näidetega. Teise osa aluseks on aga üks natuke suurem näide, mis põhineb trips-traps-trulli mängul.

Programmide interaktiivseks muutmisel on Javas olulisel kohal sündmused (events). Põhimõtteliselt võib sündmust (klassi Event isendit) võtta kui teadet, et midagi juhtus - võib-olla vajutati nuppu või liigutati hiirt või pandi aken kinni. Oma klass Event on olemas nii AWT-s kui Swingis. Käesolevas materjalis on vaatluse all aga JavaFX vastav klass (javafx.event.Event). Sellel klassil on suur hulk otseseid ja kaudseid alamklasse, mille abil on võimalik korraldada reageerimine väga erinevatele tegevustele. Klassi nimega on püütud vihjata, mislaadi sündmusega tegemist on, näiteks KeyEvent (klahvisündmus), DragEvent (lohistamissündmus), TouchEvent (puutesündmus). Käesolevas materjalis on vaadeldud neist vaid mõnda, lootuses, et nende eeskujul saab juba teistega paremini hakkama.

Laias laastus saab eristada järgmisi etappe:

• midagi juhtub (näiteks hiirekursor liigub ringi peale);
• sellest teatatakse (kellele ettenähtud) ja teade liigub teatud teed pidi (mis on täis ohte ja üllatusi :-));
• teatele (sündmusele) reageeritakse (näiteks värvub ring roheliseks).

Igas sündmuses sisaldub info sündmuse tüübi (event type), allika (source) ja sihi (target) kohta. Allikast ja sihist otseselt siin materjalis ei räägita. Sündmuste tüübid on aga selles praktikumis tähtsal kohal. Sündmuse tüübina peetakse siin silmas mitte konkreetset klassi (nt. MouseEvent), vaid selle klassi sündmused on jaotatud veel täpsemalt tüüpideks (nt. MOUSE_ENTERED, MOUSE_EXITED, MOUSE_PRESSED, MOUSE_RELEASED). Paljude klasside puhul on üheks sündmuse tüübiks ANY, mis on siis nagu ülemtüübiks teiste tüüpide suhtes.

Enesekontroll

Hiire sündmuste käsitlemine

Järgmises näites on kasutusel mugavusmeetod (convenience method) setOnMouseEntered, mis määrab MOUSE_ENTERED tüüpi sündmuse käsitleja (event handler). (Mugavusmeetodid on kirjeldatud klassis Node.) Meetodi argument peab olema EventHandler liidest (kirjeldab meetodi handle) realiseeriva klassi isend. Ise EventHandlerit realiseerides saamegi määrata, kuidas sündmuse peale peaks reageerima.

Enamasti reageeritakse igale sündmusele erimoodi. Kui iga reaktsiooni jaoks peaks looma uue EventHandlerit realiseeriva klassi, oleks vaja kirjutada tüütult palju erinevaid väikseid klasse. Õnneks on Javas olemas anonüümsed klassid (täpsemalt siin) - ilma nimeta klassid, mille saab defineerida klassist isendi loomise hetkel. Selline kirjapilt on lühem ja mugavam. Allpool näites luuakse uus klass, mis realiseerib EventHandler liidest. Kui kursor läheb punase ringi peale, kutsub JavaFX meie handle meetodi, mis väljastab ekraanile vastava teate.

Circle ring1 = new Circle(100, 100, 100, Color.RED);
// setOnMouseEntered määrab sündmuse käsitleja
// käsitleja defineeritakse anonüümse klassiga
ring1.setOnMouseEntered(new EventHandler<MouseEvent>() {
  public void handle(MouseEvent me) {
    // siin saab kasutada ka ümbritsevas skoobis olevaid muutujaid, nt ring1
    System.out.println("Hiir läks ringi peale");
  }
}); // loogeline sulg lõpetab klassi ja tavaline sulg meetodi väljakutse

Lisaks mugavusmeetodile saab kasutada ka üldisemat varianti käsitleja määramiseks, nimelt mugavusmeetodeid ei ole kõigi sündmuste klasside ja tüüpide jaoks. Nii saab kasutada meetodit addEventHandler, mille argumentidega saab määrata sündmuse tüübi ja käsitleja. Näiteks ülaltooduga analoogiliselt toimib järgmine lõik.

ring1.addEventHandler(MouseEvent.MOUSE_ENTERED, new EventHandler<MouseEvent>() {
  public void handle(MouseEvent me) {
    System.out.println("Hiir läks ringi peale");
  }
});

Klass, mis eelmistes näidetes on anonüümse klassina, võib olla ka nimega siseklassina või ka eraldi nö. tavalise klassina.

class Käsitleja implements EventHandler<MouseEvent> {
  public void handle(MouseEvent me) {
    System.out.println("Hiir läks ringi peale");
  }
}

Sellisel juhul tuleb jätkata ühega järgmistest variantidest.

ring1.addEventHandler(MouseEvent.MOUSE_ENTERED, new Käsitleja()); 

või

ring1.setOnMouseEntered(new Käsitleja());

Eraldi failis olev käsitleja klass on kasulik näiteks siis, kui sama tegevust tahetakse kasutada erinevate klasside sündmuste puhul.

Enesekontroll

class Käsitleja implements EventHandler<MouseEvent> {
  private Circle circle;

  public Käsitleja(Circle circle) {
    this.circle = circle;
  }

  public void handle(MouseEvent me) {
    circle.setFill(Color.GREEN);
  }
}

Aga see pole veel kõik! Alates Java 8. versioonist on võimalik kasutada ka lambda-avaldisi, mis võimaldavad eeltoodut veel kompaktsemalt esitada. Näiteks

ring1.setOnMouseEntered(event -> System.out.println("Hiir läks ringi peale"));

Lambda-avaldiste kohta saab rohkem infot: https://docs.oracle.com/javase/tutorial/java/javaOO/lambdaexpressions.html.

Meie oma aines piirdume hetkel vaid kasutamisega ja põhjalikumalt lambda-avaldistesse ei süüvi.

Näiteid erinevatest sündmuse käsitlemise võimalustest

Eelmistes näidetes olid kesksel kohal hiiresündmused. Tegelikult on võimalusi muidugi palju rohkem. Järgmises näites ongi päris mitmeid neist kasutatud. Kuna sündmuste klasside hulk on üsna väike, siis väga paljude graafiliste komponentide jaoks kasutatakse hoopis "muutuste kuularit" (isendit klassist, mis realiseerib liidest ChangeListener). Selle liidese realiseerimiseks peab olema lisatud meetod changed. Kuulata saab erinevate graafiliste komponentide erinevate omaduste (property) muutusi, nt. akna suuruse muutumist (widthProperty ja heightProperty nt. klassi Stage isendi puhul). Järgmises näites on kuulatud listivaate omadust selectedItemProperty.

public void start(Stage peaLava) {
  BorderPane piir = new BorderPane();

  // tekstivälja loomine ja lisamine piiripaanile (üles)
  TextField tekst = new TextField();
  tekst.setText("mingi tekst");
  piir.setTop(tekst);

  // sündmuse lisamine tekstiväljale (klahvisündmus reageerib
  // ainult enter-i vajutamisele)
  tekst.setOnKeyPressed(new EventHandler<KeyEvent>() {
    public void handle(KeyEvent keyEvent) {
      if (keyEvent.getCode() == KeyCode.ENTER) {
        tekst.setText("nüüd vajutasin ENTER");
      }
    }
  });

  // listivaate loomine ja lisamine piiripaanile (keskele)
  ListView<String> list = new ListView<String>();
  ObservableList<String> items = FXCollections.observableArrayList("Esimene", "Teine",
      "Kolmas", "Neljas");
  list.setItems(items);
  piir.setCenter(list);

  // listivaate omaduse kuulamine (kui midagi valitakse,
  // siis see omadus muutub)
  list.getSelectionModel().selectedItemProperty().addListener(new ChangeListener<String>() {
    public void changed(ObservableValue<? extends String> ov, String oldValue, String newValue) {
      tekst.setText(newValue);
    }
  });


  // teine piiripaan, mis pannakse esimesele piiripaanile alla
  // teisele piiripaanile tuleb 2 nuppu, üks vasakule ja
  // üks paremale
  BorderPane piir2 = new BorderPane();
  Button nupp1 = new Button("1");
  piir2.setLeft(nupp1);
  Button nupp2 = new Button("2");
  piir2.setRight(nupp2);
  piir.setBottom(piir2);


  // hiiresündmuse lisamine teisele piiripaanile
  piir2.setOnMouseClicked(new EventHandler<MouseEvent>() {
    public void handle(MouseEvent me) {
      tekst.setText("nüüd uus tekst");
    }
  });


  // klahvisündmuse lisamine esimele nupule
  nupp1.setOnKeyPressed(new EventHandler<KeyEvent>() {
    public void handle(KeyEvent keyEvent) {
      if (keyEvent.getCode() == KeyCode.DIGIT1) {
        tekst.setText("nüüd 1");
      }
    }
  });


  // hiiresündmuse lisamine teisele nupule
  nupp2.setOnMouseClicked(new EventHandler<MouseEvent>() {
    public void handle(MouseEvent me) {
      tekst.setText("nüüd 2");
    }
  });


  // aknasündmuse lisamine
  peaLava.setOnHiding(new EventHandler<WindowEvent>() {
    public void handle(WindowEvent event) {
      // luuakse teine lava
      Stage kusimus = new Stage();
      // küsimuse ja kahe nupu loomine
      Label label = new Label("Kas tõesti tahad kinni panna?");
      Button okButton = new Button("Jah");
      Button cancelButton = new Button("Ei");

      // sündmuse lisamine nupule Jah
      okButton.setOnAction(new EventHandler<ActionEvent>() {
        public void handle(ActionEvent event) {
          kusimus.hide();
        }
      });

      // sündmuse lisamine nupule Ei
      cancelButton.setOnAction(new EventHandler<ActionEvent>() {
        public void handle(ActionEvent event) {
          peaLava.show();
          kusimus.hide();
        }
      });

      // nuppude grupeerimine
      FlowPane pane = new FlowPane(10, 10);
      pane.setAlignment(Pos.CENTER);
      pane.getChildren().addAll(okButton, cancelButton);

      // küsimuse ja nuppude gruppi paigutamine
      VBox vBox = new VBox(10);
      vBox.setAlignment(Pos.CENTER);
      vBox.getChildren().addAll(label, pane);

      //stseeni loomine ja näitamine
      Scene stseen2 = new Scene(vBox);
      kusimus.setScene(stseen2);
      kusimus.show();
    }
  }); //siin lõpeb aknasündmuse kirjeldus


  // stseeni loomine ja näitamine
  Scene stseen1 = new Scene(piir, 300, 150, Color.SNOW);
  peaLava.setTitle("Sündmused");
  peaLava.setResizable(false);
  peaLava.setScene(stseen1);
  peaLava.show();
}

Trips-traps-trull - näide suuremast programmist

Praktikumi järgmine osa põhineb trips-traps-trulli mängul. Proovi see oma IDEs avada ja käivitada. Projekti avamisel on abiks juhend.