shadowstring.java

ALGAE是一个快速创建算法演示的框架。目前支持的算法实现语言包括java和c

package edu.odu.cs.zeil.AlgAE.Demos.Utils;

import edu.odu.cs.zeil.AlgAE.Direction;
import edu.odu.cs.zeil.AlgAE.Server.Rendering;
import edu.odu.cs.zeil.AlgAE.Server.Visible;
import edu.odu.cs.zeil.AlgAE.Server.VisibleRendering;

import java.awt.Color;


/**
 * Useful class for portraying strings within algorithm animations.
 *
 * @author Steven Zeil
 */
public class ShadowString implements Visible
{
  private VisibleRendering vr;
  private String theString;
  

  /**
   *  Create a shadow object that takes its portrayal from a normal
   *  Java string.
   */
  ShadowString (String str, Color color)
  {
    theString = str;
    vr = new VisibleRendering (this, color);
  }


  /**
   * This function returns the VisibleRendering data member
   *
   * @return  the rendering information for this object.
   **/
  public Rendering getRendering()
  {
    return vr;
  }
  
    

  /**
   * Produce the text string to be displayed in the picture of the object.
   *
   * @return the text string to be displayed
   **/
  public String getAlgAEText()
  {
    return theString;
  }
  

  /**
   * If an object <CODE>s</CODE> is to be portrayed as having 
   * pointers/references/arrows to other Visible objects, then when
   * <CODE>s.touchAllPointers()</CODE> is called, 
   * the body of <CODE>touchAllPointers</CODE> should call, for each arrow
   * from <CODE>s</CODE> to another Visible object <CODE>p</CODE>,
   * <CODE>s.getRendering().touch(p, dir)</CODE> or
   * <CODE>s.getRendering().touch(p, dir, label)</CODE>.
   * <P>
   * <CODE>dir</CODE> is the "exit" direction from which the AlgAE system
   * will draw the arrow from <CODE>s</CODE> to <CODE>p</CODE>.
   **/
  public void touchAllPointers()
  {
  }
  

  /**
   * If an object <CODE>s</CODE> is to be portrayed as a compound structure
   * containing other Visible objects, then when
   * <CODE>s.touchAllComponents()</CODE> is called, 
   * the body of <CODE>touchAllComponents</CODE> should call, for each
   * contained Visible component <CODE>p</CODE>,
   * <CODE>s.getRendering().touch(p)</CODE>.
   * <P>
   * Note that the the distinction between a "Pointer" and a "Component"
   * is a logical distinction, as they are both typically implemented as
   * simple data members of the Visible class.  It is up to the designer
   * of the algorithm animation to decide what to portray as references and
   * what to portray as contained components.
   **/
  public void touchAllComponents()
  {
  }


}