JGraphpadCodecPlugin.java :  » Graphic-Library » jgraphpad » com » jgraph » codecplugin » Java Open Source

/* 
 * $Id: JGraphpadCodecPlugin.java,v 1.1.1.1 2005/08/04 11:21:58 gaudenz Exp $
 * Copyright (c) 2001-2005, Gaudenz Alder
 * 
 * All rights reserved.
 * 
 * See LICENSE file for license details. If you are unable to locate
 * this file please contact info (at) jgraph (dot) com.
 */
package com.jgraph.codecplugin;

import java.io.IOException;

import javax.xml.parsers.ParserConfigurationException;

import org.jgraph.JGraph;
import org.jgraph.graph.CellView;
import org.jgraph.graph.GraphModel;
import org.w3c.dom.Node;
import org.xml.sax.SAXException;

import com.jgraph.JGraphEditor;
import com.jgraph.JGraphpad;
import com.jgraph.editor.JGraphEditorPlugin;
import com.jgraph.editor.JGraphEditorResources;
import com.jgraph.editor.JGraphEditorSettings;

/**
 * Plugin for exporting JGraphpad files to various formats, namely HTML image
 * maps, GXL and Graphviz.
 */
public class JGraphpadCodecPlugin implements JGraphEditorPlugin {

  /**
   * Defines the path to the UI configuration to be merged into the existing
   * UI configuration.
   */
  public static String PATH_UICONFIG = "/com/jgraph/codecplugin/resources/ui.xml";

  /**
   * Adds resource bundles.
   */
  static {
    JGraphEditorResources
        .addBundles(new String[] { "com.jgraph.codecplugin.resources.strings" });
  }

  /**
   * Utilitiy method used by some of the codecs to determine whether a cell is
   * a vertex. This implementation takes into account the current collapsed
   * state.
   * 
   * @param graph
   *            The graph that contains the cell.
   * @param cell
   *            The cell to be checked.
   * @return Returns true if <code>cell</code> is a vertex.
   */
  public static boolean isVertex(JGraph graph, Object cell) {
    GraphModel model = graph.getModel();
    CellView view = graph.getGraphLayoutCache().getMapping(cell, false);
    return view != null && view.isLeaf() && !model.isEdge(cell)
        && !model.isPort(cell);
  }

  /**
   * Initializes the plugin by registering all factory methods and action
   * bundles and merging the UI configuration into the main configuration.
   * 
   * @param editor
   *            The enclosing editor for the plugin.
   * @param configuration
   *            The object to configure the plugin with.
   */
  public void initialize(JGraphEditor editor, Node configuration)
      throws ParserConfigurationException, SAXException, IOException {
    editor.getKit().addBundle(new JGraphpadCodecAction.AllActions(editor));
    editor.getSettings().add(
        JGraphpad.NAME_UICONFIG,
        JGraphEditorSettings.parse(JGraphEditorResources
            .getInputStream(PATH_UICONFIG)));
  }

}