Menu.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Author: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz
 * File: Menu.java
 * Description: Backbean for template.xhtml, class for menu handling
 */

/**
 * @file Menu.java
 *
 * @brief Backbean for template.xhtml, class for menu handling
 */

package cz.vutbr.fit.knot.annotations.web;

import java.io.Serializable;
import javax.faces.bean.ManagedBean;
import javax.faces.bean.SessionScoped;

/**
 * Backbean for template.xhtml, class for menu handling
 * 
 * @brief Backbean for template.xhtml, class for menu handling
 * @author idytrych
 */
@ManagedBean
@SessionScoped
public class Menu implements Serializable {
  /**
   * Page actually displayed
   */
  private String actualPage = "index";

  /**
   * Action listener for all menu buttons (except log off)
   * - ensure the transition
   * - clears errors on login page
   * 
   * @param newPage New page to display (identification of button)
   * @return Returns page outcome (identification of transition)
   */
  public String menuAction(String newPage) {
    if (!actualPage.equals("login") && newPage.equals("login")) {
      Login loginBean = (Login) SessionManager.getBeanByName("login");
      loginBean.setBadCredentials(false);
    }
    actualPage = newPage;
    return newPage;
  }

  /**
   * Action listener for log off menu button
   * - log off the user
   * - switch to index page
   * 
   * @return Returns page outcome to go to index page
   */
  public String logoffAction() {
    SessionManager.getSession().setNotLoggedIn();
    Login loginBean = (Login) SessionManager.getBeanByName("login");
    if (loginBean != null) {  // clean up login form
      loginBean.setLogin("");
      loginBean.setPassword("");
      loginBean.setBadCredentials(false);
    }
    actualPage = "index";
    return "index";
  }

  /**
   * Returns whether menu item is disabled (page is now displayed)
   * 
   * @param page Identificator of menu item
   * @return If page is now displayed, returns true, false otherwise
   */
  public String isDisabled(String page) {
    if (page == null ? actualPage == null : page.equals(actualPage)) {
      return "true";
    } else {
      return "false";
    }
  }

  /**
   * Gets whether user is logged in
   * 
   * @return If user is logged in, returns true, false otherwise
   */
  public boolean getLoggedIn() {
    return SessionManager.getSession().isLoggedIn();
  }

  /**
   * Returns whether user is an administrator
   *
   * @return If user is administrator, returns true, false otherwise
   */
  public boolean getIsAdmin() {
    return SessionManager.getSession().isAdmin();
  }

  /**
   * Gets identification of now displayed page
   * 
   * @return Returns identification of page now displayed
   */
  public String getActualPage() {
    return actualPage;
  }

  /**
   * Sets page now displayed (for transitions out of menu)
   * 
   * @param actualPage Identificator of actually displayed page
   */
  public void setActualPage(String actualPage) {
    this.actualPage = actualPage;
  }

  /**
   * Constructor
   */
  public Menu() {
  }

}  // public class Menu