org.tentackle.swing.rdc.PdoTreeExtension Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tentackle-swing-rdc Show documentation
Rich Desktop Client based on Tentackle Swing
There is a newer version: 8.3.0.1
/**
 * Tentackle - http://www.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
 */

// Created on February 5, 2004, 7:57 PM

package org.tentackle.swing.rdc;

import java.awt.datatransfer.Transferable;
import java.util.List;
import javax.swing.ImageIcon;
import javax.swing.JMenuItem;
import javax.swing.tree.DefaultMutableTreeNode;

/**
 * Interface to add features to objects displayed in an {@link PdoTree}.
 * 
 *
 * Objects must implement this interface if:
 * 

 * they are not a persistent object (i.e. kind of "proxy"-object)
 * their handling differs from the default for a persistent object (see PdoTree when to use)
 * 
 *
 * @author harald
 */
public interface PdoTreeExtension {

  /**
   * Defines an editor that will be invoked to "open" this tree object.

   * "open" usually means to open a dialog.
   * A special menu-item will be created in the popup-menu for those objects.
   * (ex. to work on a PDF-Document)
   * The object itself will not be reloaded before the runnable is executed.
   *
   * @return a editor if objects needs a special way to "open" it, null = none.
   */
  Runnable getOpenEditor();


  /**
   * Defines an editor that will be invoked to edit this tree object.

   * The editor should be a modal dialog, i.e. not return until editing is done.
   *
   * @return the editor, null = no special editor, i.e. use default editor
   */
  PdoTreeExtensionEditor getEditor();


  /**
   * Defines additional menu items in the popup menu.
   *
   * @param tree the tree
   * @param node the node the popup menu refers to
   * @return an array of additional {@code JMenuItems} to be appended to the popup-menu, null = none
   */
  JMenuItem[] getExtraMenuItems(PdoTree tree, DefaultMutableTreeNode node);


  /**
   * Defines additional toggle nodes.
   *
   * @param tree the tree
   * @param node the node the popup menu refers to
   * @return an array of additional {@code PdoTreeExtensionToggleNode} to be prepended to the popup-menu, null = none
   */
  PdoTreeExtensionToggleNode[] getToggleNodes(PdoTree tree, DefaultMutableTreeNode node);




  // ------------------- from PdoGuiService, i.e. if tree object is not a persistent object -------


  /**
   * Gets the {@link Transferable} for this object.

   * Used for drag and drop.
   *
   * @return the transferable, null if none
   */
  Transferable getTransferable();


  /**
   * Drops a transferable on this object.

   *
   * @param transferable the Transferable
   * @return true if drop succeeded, else false
   */
  boolean dropTransferable(Transferable transferable);


  /**
   * Returns whether this object can be removed.
   *
   * @return true if removable
   */
  boolean isRemovable();


  /**
   * Determines whether this object may have child objects that should
   * be visible in a navigatable tree.
   *
   * @return true if object may have childs
   */
  boolean allowsTreeChildObjects();


  /**
   * Gets all childs of this objects that should be visible to the user
   * in a navigatable object tree.
   *
   * @return the childs, null = no childs
   */
  List