org.tentackle.fx.rdc.PdoViewer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tentackle-fx-rdc Show documentation

Rich Desktop Client based on FX

There is a newer version: 21.16.1.0

/*
 * Tentackle - https://tentackle.org
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.tentackle.fx.rdc;

import org.tentackle.pdo.PersistentDomainObject;

/**
 * A wrapper for some view controller that can be used as a pdo editor.

 * Useful to view PDOs that cannot be edited.
 * 
 * Example (in a GuiProvider):
 * 
 *   @Override
 *   public PdoEditor<Incident> createEditor() {
 *     return new PdoViewer<Incident, IncidentView>(Fx.load(IncidentView.class));
 *   }
 *
 *   @Override
 *   public boolean isEditAllowed() {
 *     return false;   // disable the edit item in the context menu
 *   }
 * 
 *
 * @param  the PDO type
 * @param  the controller type
 */
public class PdoViewer, C extends PdoController>
       extends PdoEditor {

  private final C viewController;

  /**
   * Creates a view wrapper.
   *
   * @param viewController the view controller
   */
  public PdoViewer(C viewController) {
    this.viewController = viewController;
    setView(viewController.getView());
  }

  /**
   * Gets the view controller.
   *
   * @return the controller
   */
  public C getViewController() {
    return viewController;
  }

  @Override
  public T getPdo() {
    return viewController.getPdo();
  }

  /**
   * Sets the PDO.

   *
   * @param pdo the pdo
   */
  public void setPdo(T pdo) {
    viewController.setPdo(pdo);
  }

  @Override
  public void requestInitialFocus() {
    // default does nothing, assumes setPdo() does it already. Otherwise override!
  }

  @Override
  public boolean isEditAllowed() {
    return false;   // this is just a viewer!
  }

}