Class BasicGraphUI

Method Details

• createUI

  public static ComponentUI createUI(JComponent x)

• setModel

  protected void setModel(GraphModel model)

  Sets the GraphModel. This invokes updateSize.

• setGraphLayoutCache

  protected void setGraphLayoutCache(GraphLayoutCache cache)

  Sets the GraphLayoutCache (geometric pattern). This invokes updateSize.

• setMarquee

  protected void setMarquee(BasicMarqueeHandler marqueeHandler)

  Sets the marquee handler.

• setSelectionModel

  protected void setSelectionModel(GraphSelectionModel newLSM)

  Resets the selection model. The appropriate listeners are installed on the model.

• getHandle

  public CellHandle getHandle()

  Returns the handle that is currently active, or null, if no handle is currently active. Typically, the returned objects are instances of the RootHandle inner class.

  Specified by:

  getHandle in class GraphUI

• getDropAction

  public int getDropAction()

  Returns the current drop action.

  Specified by:

  getDropAction in class GraphUI

• getFocusedCell

  protected Object getFocusedCell()

  Returns the cell that has the focus.

• getPreferredSize

  public Dimension2D getPreferredSize(JGraph graph, CellView view)

  Get the preferred Size for a cell view.

  Specified by:

  getPreferredSize in class GraphUI

• getInsertionLocation

  public Point getInsertionLocation()

  Returns the current location of the Drag-and-Drop activity.

  Specified by:

  getInsertionLocation in class GraphUI

• setInsertionLocation

  public void setInsertionLocation(Point p)

  Sets the current location for Drag-and-Drop activity. Should be set to null after a drop. Used from within DropTargetListener.

  Specified by:

  setInsertionLocation in class GraphUI

• selectCellsForEvent

  public void selectCellsForEvent(JGraph graph, Object[] cells, MouseEvent event)

  From GraphUI interface.

  Specified by:

  selectCellsForEvent in class GraphUI

• selectCellsForEvent

  public void selectCellsForEvent(Object[] cells, MouseEvent event)

  Messaged to update the selection based on a MouseEvent for a group of cells. If the event is a toggle selection event, the cells are either selected, or deselected. Otherwise the cells are selected.

• selectCellForEvent

  public void selectCellForEvent(Object cell, MouseEvent event)

  Messaged to update the selection based on a MouseEvent over a particular cell. If the event is a toggle selection event, the cell is either selected, or deselected. Otherwise the cell is selected.

• toggleSelectionCellForEvent

  protected void toggleSelectionCellForEvent(Object cell, MouseEvent event)

  Messaged to update the selection based on a toggle selection event, which means the cell's selection state is inverted.

• isAddToSelectionEvent

  public boolean isAddToSelectionEvent(MouseEvent e)

  Returning true signifies that cells are added to the selection.

• isToggleSelectionEvent

  public boolean isToggleSelectionEvent(MouseEvent e)

  Returning true signifies a mouse event on the cell should toggle the selection of only the cell under mouse.

• isForceMarqueeEvent

  public boolean isForceMarqueeEvent(MouseEvent event)

  Returning true signifies the marquee handler has precedence over other handlers, and is receiving subsequent mouse events.

• isConstrainedMoveEvent

  public boolean isConstrainedMoveEvent(MouseEvent event)

  Returning true signifies a move should only be applied to one direction.

• isEditing

  public boolean isEditing(JGraph graph)

  Returns true if the graph is being edited. The item that is being edited can be returned by getEditingPath().

  Specified by:

  isEditing in class GraphUI

• stopEditing

  public boolean stopEditing(JGraph graph)

  Stops the current editing session. This has no effect if the graph isn't being edited. Returns true if the editor allows the editing session to stop.

  Specified by:

  stopEditing in class GraphUI

• cancelEditing

  public void cancelEditing(JGraph graph)

  Cancels all current editing sessions.

  Specified by:

  cancelEditing in class GraphUI

• startEditingAtCell

  public void startEditingAtCell(JGraph graph, Object cell)

  Selects the cell and tries to edit it. Editing will fail if the CellEditor won't allow it for the selected item.

  Specified by:

  startEditingAtCell in class GraphUI

• getEditingCell

  public Object getEditingCell(JGraph graph)

  Returns the element that is being edited.

  Specified by:

  getEditingCell in class GraphUI

• installUI

  public void installUI(JComponent c)

  Overrides:

  installUI in class ComponentUI

• prepareForUIInstall

  protected void prepareForUIInstall()

  Invoked after the graph instance variable has been set, but before any defaults/listeners have been installed.

• completeUIInstall

  protected void completeUIInstall()

  Invoked from installUI after all the defaults/listeners have been installed.

• installDefaults

  protected void installDefaults()

  Invoked as part from the boilerplate install block. This sets the look and feel specific variables in JGraph.

• installListeners

  protected void installListeners()

  Invoked as part from the boilerplate install block. This installs the listeners from BasicGraphUI in the graph.

• installKeyboardActions

  protected void installKeyboardActions()

  Invoked as part from the boilerplate install block.

• installComponents

  protected void installComponents()

  Intalls the subcomponents of the graph, which is the renderer pane.

• createTransferHandler

  protected TransferHandler createTransferHandler()

  Creates an instance of TransferHandler. Used for subclassers to provide different TransferHandler.

• createPropertyChangeListener

  protected PropertyChangeListener createPropertyChangeListener()

  Creates a listener that is responsible to update the UI based on how the graph's bounds properties change.

• createMouseListener

  protected MouseListener createMouseListener()

  Creates the listener responsible for calling the correct handlers based on mouse events, and to select invidual cells.

• createKeyListener

  protected KeyListener createKeyListener()

  Creates the listener reponsible for getting key events from the graph.

• createGraphSelectionListener

  protected GraphSelectionListener createGraphSelectionListener()

  Creates the listener that updates the display based on selection change methods.

• createCellEditorListener

  protected CellEditorListener createCellEditorListener()

  Creates a listener to handle events from the current editor.

• createComponentListener

  protected ComponentListener createComponentListener()

  Creates and returns a new ComponentHandler.

• createCellRendererPane

  protected CellRendererPane createCellRendererPane()

  Returns the renderer pane that renderer components are placed in.

• createGraphLayoutCacheListener

  protected GraphLayoutCacheListener createGraphLayoutCacheListener()

  Returns a listener that can update the graph when the view changes.

• createGraphModelListener

  protected GraphModelListener createGraphModelListener()

  Returns a listener that can update the graph when the model changes.

• uninstallUI

  public void uninstallUI(JComponent c)

  Overrides:

  uninstallUI in class ComponentUI

• completeUIUninstall

  protected void completeUIUninstall()

• uninstallListeners

  protected void uninstallListeners()

• uninstallKeyboardActions

  protected void uninstallKeyboardActions()

• uninstallComponents

  protected void uninstallComponents()

  Uninstalls the renderer pane.

• paint

  public void paint(Graphics g, JComponent c)

  Main painting routine.

  Overrides:

  paint in class ComponentUI

• paintOverlay

  protected void paintOverlay(Graphics g)

  Hook method to paints the overlay

  Parameters:

  g - the graphics object to paint the overlay to

• drawGraph

  public void drawGraph(Graphics g, Rectangle2D clipBounds)

  Draws the graph to the specified graphics object within the specified clip bounds, if any

  Parameters:

  g - the graphics object to draw the graph to

  clipBounds - the bounds within graph cells must intersect to be redrawn

• paintCells

  protected void paintCells(Graphics g, Rectangle2D realClipBounds)

  Hook method to allow subclassers to alter just the cell painting functionality

  Parameters:

  g - the graphics object to paint to

  realClipBounds - the bounds of the region being repainted

• paintCell

  public void paintCell(Graphics g, CellView view, Rectangle2D bounds, boolean preview)

  Paints the renderer of view to g at bounds. Recursive implementation that paints the children first.

  The reciever should NOT modify clipBounds, or insets. The preview flag is passed to the renderer, and is not used here.

  Specified by:

  paintCell in class GraphUI

• paintBackground

  protected void paintBackground(Graphics g)

  Paint the background of this graph. Calls paintGrid.

• paintBackgroundImage

  protected void paintBackgroundImage(Graphics g, Rectangle clip)

  Hook for subclassers to paint the background image.

  Parameters:

  g - The graphics object to paint the image on.

  clip - The clipping region to draw into

• paintBackgroundComponent

  protected void paintBackgroundComponent(Graphics g, Component component)

  Requests that the component responsible for painting the background paint itself

  Parameters:

  g - The graphics object to paint the image on.

  component - the component to be painted onto the background image

• paintBackgroundComponent

  protected void paintBackgroundComponent(Graphics g, Component component, Rectangle clip)

  Requests that the component responsible for painting the background paint itself

  Parameters:

  g - The graphics object to paint the image on.

  component - the component to be painted onto the background image

  clip - The clipping region to draw into

• paintGrid

  protected void paintGrid(double gs, Graphics g, Rectangle2D clipBounds)

  Paint the grid.

• paintForeground

  protected void paintForeground(Graphics g)

  Paint the foreground of this graph. Calls paintPorts.

• paintPorts

  public void paintPorts(Graphics g, CellView[] ports)

  Paint ports.

  Specified by:

  paintPorts in class GraphUI

• updateHandle

  public void updateHandle()

  Update the handle using createHandle.

  Specified by:

  updateHandle in class GraphUI

• createContext

  protected GraphContext createContext(JGraph graph, Object[] cells)

• createHandle

  public CellHandle createHandle(GraphContext context)

  Constructs the "root handle" for context.

  Parameters:

  context - reference to the context of the current selection.

• updateSize

  public void updateSize()

  Messages the Graph with graphDidChange.

• updateCachedPreferredSize

  protected void updateCachedPreferredSize()

  Updates the preferredSize instance variable, which is returned from getPreferredSize().

• setPreferredMinSize

  public void setPreferredMinSize(Dimension newSize)

  Sets the preferred minimum size.

• getPreferredMinSize

  public Dimension getPreferredMinSize()

  Returns the minimum preferred size.

• getPreferredSize

  public Dimension getPreferredSize(JComponent c)

  Returns the preferred size to properly display the graph.

  Overrides:

  getPreferredSize in class ComponentUI

• getMinimumSize

  public Dimension getMinimumSize(JComponent c)

  Returns the minimum size for this component. Which will be the min preferred size or 0, 0.

  Overrides:

  getMinimumSize in class ComponentUI

• getMaximumSize

  public Dimension getMaximumSize(JComponent c)

  Returns the maximum size for this component, which will be the preferred size if the instance is currently in a JGraph, or 0, 0.

  Overrides:

  getMaximumSize in class ComponentUI

• completeEditing

  protected void completeEditing()

  Messages to stop the editing session. If the UI the receiver is providing the look and feel for returns true from getInvokesStopCellEditing, stopCellEditing will invoked on the current editor. Then completeEditing will be messaged with false, true, false to cancel any lingering editing.

• completeEditing

  protected void completeEditing(boolean messageStop, boolean messageCancel, boolean messageGraph)

  Stops the editing session. If messageStop is true the editor is messaged with stopEditing, if messageCancel is true the editor is messaged with cancelEditing. If messageGraph is true the graphModel is messaged with valueForCellChanged.

• startEditing

  protected boolean startEditing(Object cell, MouseEvent event)

  Will start editing for cell if there is a cellEditor and shouldSelectCell returns true.

  This assumes that cell is valid and visible.

• getEditorLocation

  protected Point2D getEditorLocation(Object cell, Dimension2D editorSize, Point2D pt)

  Subclassers may override this to provide a better location for the in-place editing of edges (if you do not inherit from the EdgeRenderer class).

• autoscroll

  public static void autoscroll(JGraph graph, Point p)

  Scroll the graph for an event at p.

• isSnapSelectedView

  public boolean isSnapSelectedView()

  Returns:

  true if snapSelectedView mode is enabled during the drag operation. If it is enabled, the view, that is returned by the findViewForPoint(Point pt), will be snapped to the grid lines.
  By default, findViewForPoint() returns the first view from the GraphContext whose bounds intersect with snap proximity of a mouse pointer. If snap-to-grid mode is disabled, views are moved by a snap increment.

• setSnapSelectedView

  public void setSnapSelectedView(boolean snapSelectedView)

  Sets the mode of the snapSelectedView drag operation.

  Parameters:

  snapSelectedView - specifies if the snap-to-grid mode should be applied during a drag operation. If it is enabled, the view, that is returned by the findViewForPoint(Point pt), will be snapped to the grid lines.
  By default, findViewForPoint() returns the first view from the GraphContext whose bounds intersect with snap proximity of a mouse pointer. If snap-to-grid mode is disabled, views are moved by a snap increment.