All Packages  Class Hierarchy

Index of all Fields and Methods

A

action(Event, Object). Method in class AlgAnimApp

The start_button action handling method, which is automatically invoked when the button is pressed.

action(Event, Object). Method in class AlgAnimFrame

Action handler for the buttons and choice buttons in the control panel.

action(Event, Object). Method in class ControlPanel

Action handler for the buttons and choice buttons in the control panel.

addCom(ComBox). Method in class DrawingPanel

Adds a commentary box to the drawing panel.

addDrawingObj(DrawingObj). Method in class DrawingPanel

Adds a drawing object to the canvas.

addTableEntry(Object, int). Method in class TableCanvas

Add an entry to the table and push the existing entries after this newly added object one position down.

addTableEntry(Object, int). Method in class TablePanel

Pass the method call to the corresponding TableCanvas, which add an entry to the table and push the existing entries after this newly added object one position down.

AlgAnimApp(). Constructor for class AlgAnimApp

This constructor is not to be manually called.

AlgAnimFrame(AlgAnimApp, URL). Constructor for class AlgAnimFrame

Creates and shows the frame consists of a drawing panel, commentary panel and control panel.

AlgThread(AlgAnimFrame). Constructor for class AlgThread

Creates a new thread using the frame passed in as the parameter.

animate(DrawingObj, Vector). Method in class DrawingPanel

Animate a single drawing object through a sequence of points specified by the Vector construction.

animate(DrawingObj[], Vector[]). Method in class DrawingPanel

Animate a list of drawing objects store in an array.

C

ComBox(int, int, String, Color, Color, Font). Constructor for class ComBox

Creates a commentary box with its topleft corner at (topLeftX, topLeftY) and the commentary text specified by the third String parameter, using the foreground and background colors indicated by the fourth and fifth parameters.

ComBox(int, int, String, Font). Constructor for class ComBox

Creates a commentary box with its topleft corner at (topLeftX, topLeftY) and the commentary text specified by the third String parameter.

ComPanel(String, int). Constructor for class ComPanel

Creates a commentary panel based on the initial comment and number of text fields specified by the parameters.

contains(Object). Method in class TableCanvas

Check if the table contains a certain object specified by the parameter.

contains(Object). Method in class TablePanel

Pass the method call to the corresponding TableCanvas, which checks if the table contains a certain object specified by the parameter.

ControlPanel(AlgAnimFrame, String). Constructor for class ControlPanel

Creates a panel to hold the control buttons of the animation tool.

D

dataSets. Static variable in class AlgThread

Array of strings used to set the choices of the data choice button in data menu.

delay(). Method in class DrawingPanel

Invoke a delay for a certain duration specified by setDelay(int).

delay(). Method in class TablePanel

This method causes a delay of 200msec.

draw(Graphics). Method in class ComBox

This method is to be called from the paint(Graphics g) method of the drawing panel/canvas.

draw(Graphics). Method in interface DrawingObj

Paint method of the drawing object.

draw(Graphics). Method in class Histogram

Same as paint().

draw(Graphics). Method in class IntMatrix

This method has to be defined to fully implement the DrawingObj interface.

draw(Graphics). Method in class Legend

This method draws the details of the legend object on the appropriate graphical context, normally the drawing panel.

draw(Graphics). Method in class Node

This method draws the node on the corresponding graphical context normally passed in from the drawing panel.

draw(Graphics). Method in class ShadowLabel

Draw the text string with a gray label.

draw(Graphics). Method in class TablePanel

Simply call the repaint() method of the table panel.

drawBox(Graphics, int, int, String, Color, Color, Font). Method in class IntMatrix

This method is used to draw each element of the matrix.

drawBox(Graphics, int, int, String, Color, Color, int). Method in class TableCanvas

This method is only called by the paint() method to draw each entry of the table as a box.

drawClusters(Graphics, int, int). Method in class TableCanvas

Display a status summary of the table regarding the percentage of the table being occupied, the number of clusters in the table, and a rough idea of the location of the table being occupied.

drawClusters(Graphics, int, int). Method in class TablePanel

Pass the method call to the corresponding TableCanvas.

drawingPanel. Variable in class AlgThread

A reference to the drawing panel in order to update the animation during the execution of the algorithm.

DrawingPanel(). Constructor for class DrawingPanel

Creates a panel with white background and initializes the fonts to be used during the animation.

drawMatrix(Graphics, int, int, Color, Color). Method in class IntMatrix

This method is only called from the draw method which in turn is called from the drawing panel to draw the matrix based on the position and color previously set.

E

elem(int, int). Method in class IntMatrix

Get a particular element of the matrix specified by the position given in the parameters of the method.

F

finishAlg(). Method in class AlgAnimFrame

This method is invoked at the end of the animation or when the stop button is pressed.

frame. Variable in class AlgThread

The initial caller of the constructor of this class.

full(). Method in class TableCanvas

Check if the table has been fully filled up.

full(). Method in class TablePanel

Pass the method call to the corresponding TableCanvas, which checks if the table has been fully filled up.

G

generateData(). Method in class AlgThread

Generate data based on the choice made on the menu.

getAlg(). Method in class AlgAnimFrame

Returns the reference to the AlgThread which contains the details and execution sequences of the algorithm.

getApplet(). Method in class AlgAnimFrame

Get the applet which contains a button to start up this window.

getBigFont(). Method in class DrawingPanel

Returns the font objects initialized during the class initialization, which can be readily used during the animation.

getComPanel(). Method in class AlgAnimFrame

Get the commentary panel that displays messages of any type.

getDataChoice(). Method in class AlgAnimFrame

Get the index of selected choice from the 'Select' pull menu.

getDelay(). Method in class AlgAnimFrame

Get the delay for highlighting text.

getDepth(). Method in class Node

Get the depth of his node.

getDisableAnim(). Method in class AlgAnimFrame

Get the menu item which specify if the animation is disabled.

getDrawingPanel(). Method in class AlgAnimFrame

Returns an instance of the drawing panel which is cast to its super class Panel.

getEnableAnim(). Method in class AlgAnimFrame

Get the menu item which specify if the animation is enabled.

getFixFont(). Method in class DrawingPanel

Return font objects initialized during the class initialization, which can be readily used during the animation.

getHugeFont(). Method in class DrawingPanel

Return font objects initialized during the class initialization, which can be readily used during the animation.

getLabel(). Method in class Node

Get the label of this node.

getLeftNode(). Method in class Node

Get the left child of this node.

getLineSpace(). Method in class TextPanel

Get the number of pixels used by each line of text.

getMinimumSize(). Method in class TextPanel

Return the minimum allowed dimension of the text panel.

getNoAnim(). Method in class DrawingPanel

Check if the noAnim flag is set.

getNumLines(). Method in class TextPanel

Get the number of lines of source code to be displayed on the text panel.

getOffset(). Method in class DrawingPanel

Get the number of pixel towards the edge of the panel which are not going to be drawn.

getPanelHeight(). Method in class DrawingPanel

Get the height of the drawing panel.

getPanelWidth(). Method in class DrawingPanel

Get the width of the drawing panel.

getPreferredSize(). Method in class DrawingPanel

Returns the initial preferred size of the drawing panel.

getPreferredSize(). Method in class ImageButton

Specify the dimension of the button.

getPreferredSize(). Method in class TextPanel

Returns the initial dimension of the text panel.

getRightNode(). Method in class Node

Get the right child of this node.

getRunButton(). Method in class ControlPanel

Returns an instance of the run ImageButton, which is casted to java.awt.Button

getRunItem(). Method in class AlgAnimFrame

Get the run button from the control panel.

getSkip(). Method in class DrawingPanel

Check if the animationis in the skip mode.

getSkipButton(). Method in class ControlPanel

Returns an instance of the skip ImageButton, which is casted to java.awt.Button

getSkipItem(). Method in class AlgAnimFrame

Get the skip button from the control panel.

getSmallFont(). Method in class DrawingPanel

Return font objects initialized during the class initialization, which can be readily used during the animation.

getStart(). Method in class TextPanel

Get the first line of the source code that will be displayed.

getStepButton(). Method in class ControlPanel

Returns an instance of the step ImageButton, which is casted to java.awt.Button

getStopButton(). Method in class ControlPanel

Returns an instance of the stop ImageButton, which is casted to java.awt.Button

getStopItem(). Method in class AlgAnimFrame

Get the stop button from the control panel.

getTableEntryAt(int). Method in class TableCanvas

Obtain the object placed at the table row specified by the parameter.

getTableEntryAt(int). Method in class TablePanel

Pass the method call to the corresponding TableCanvas, which obtains the object placed at the table row specified by the parameter.

getText(). Method in class ComBox

This method is called to obtain the current text string to be displayed in the commentary box.

getText(). Method in class ShadowLabel

Get the text string for this label object.

getTextFrame(). Method in class AlgAnimFrame

Returns an instance of the TextFrame used to set the layout constraints and highlight certain lines of the source code.

getTextPanel(). Method in class TextFrame

Get the text panel corresponding to this frame.

getTinyFont(). Method in class DrawingPanel

Return font objects initialized during the class initialization, which can be readily used during the animation.

getVertScrollbar(). Method in class TextFrame

Get the vertical scrollbar governing the view window of the text panel.

getWeight(). Method in class Node

Get the weight of this node.

getX(). Method in class ComBox

X coordinate of the top left position of the commentary box.

getX(). Method in interface DrawingObj

Returns the x coordinate of the drawing object's reference point.

getX(). Method in class Histogram

Get the left most position of the panel.

getX(). Method in class IntMatrix

Get the left most position of the matrix.

getX(). Method in class Legend

Get the left most position of the legend object.

getX(). Method in class Node

Get the left most position of the node.

getX(). Method in class ShadowLabel

Get the left most positionn of the shadow label.

getX(). Method in class TablePanel

Get the left most position of the table panel.

getY(). Method in class ComBox

Y coordinate of the top left position of the commentary box.

getY(). Method in interface DrawingObj

Returns the y coordinate of the drawing object's reference point.

getY(). Method in class Histogram

Get the top most position of the panel.

getY(). Method in class IntMatrix

Get the top most position of the matrix.

getY(). Method in class Legend

Get the top most position of the legend object.

getY(). Method in class Node

Get the top most position of the node.

getY(). Method in class ShadowLabel

Get the bottom most positionn of the shadow label.

getY(). Method in class TablePanel

Get the top most position of the table panel.

H

handleEvent(Event). Method in class AlgAnimFrame

Event handler of the frame.

handleEvent(Event). Method in class LFrame

Legend window event handling method to dispose the legend frame when the WINDOW_DESTROY event is received.

handleEvent(Event). Method in class TablePanel

The main purpose of this method is to handle the scrollbar event.

handleEvent(Event). Method in class TextFrame

An event handler for the text frame which handles the WINDOW_DESTROY event and vertical scrollbar.

height. Variable in class LFrame

The dimension of the frame in the number of pixels.

highlight. Variable in class Node

Attribute to indicate if the node is to be highlighted.

Highlight(int). Method in class AlgAnimFrame

Highlights the specified line of the source code on the text panel.

Highlight(int). Method in class TextPanel

Highlight a certain line of the source code.

highlightLeft. Variable in class Node

Attribute to indicate if the left branch is to be highlighted.

highlightRight. Variable in class Node

Attribute to indicate if the right branch is to be highlighted.

highlightRow(int). Method in class TableCanvas

Highlight the table entry with the row specified by the parameter.

highlightRow(int). Method in class TablePanel

Pass the method call to the corresponding TableCanvas, which highlights the table entry with the row specified by the parameter.

Histogram(). Constructor for class Histogram

A constructor to this class which set the background of the panel to white, font to size 12 PLAIN courier, and initializes the title, x-axis label, y-axis label, etc.

I

ImageButton(String, AlgAnimApp, ControlPanel). Constructor for class ImageButton

Creates an ImageButton using the gif file specified by the first parameter on the panel defined by the third parameter.

incElem(int, int, int). Method in class IntMatrix

Increment the element specified by the first two parameters by the value specified by the third parameter.

incValueX(int). Method in class Histogram

Increment the Y value of vertical bar specified by the parameter.

indexOf(Object). Method in class TableCanvas

Get the location of an object in the table.

indexOf(Object). Method in class TablePanel

Pass the method call to the corresponding TableCanvas, which gets the location of an object in the table.

init(). Method in class AlgAnimApp

Applet initialization method, which creates the button attribute.

init(). Method in class DrawingPanel

Initialize the commentary boxes and drawing objects, removing all of them from the drawing panel.

init(). Method in class Histogram

Initialize the histogram, removing all bars from the graph.

init(). Method in class TableCanvas

Initialize the table and set all entries to null.

init(int). Method in class TablePanel

Set the size of the table and rescale the scrollbar governing the table.

initColors(Color). Method in class Node

Set the color of the node.

initFonts(Font, Font). Method in class Node

Assign some font instances to reduce initialization over during redraw.

IntMatrix(int). Constructor for class IntMatrix

Construct a square matrix with number of rows = number of columns as specified by the single parameter of the constructor.

IntMatrix(int, int). Constructor for class IntMatrix

Construct a matrix with the number of rows and columns specified by the parameters of the constructor.

isComExist(ComBox). Method in class DrawingPanel

Check if a commentary box has already been added to the drawing panel.

isLeaf(). Method in class Node

Check if this node is a leaf node.

isNoAnim(). Method in class AlgAnimFrame

Obtain the status of the preferred animation style.

isObjExist(DrawingObj). Method in class DrawingPanel

Checks if a certain object has already been added to the drawing panel.

L

Legend(int, int). Constructor for class Legend

Construct a legend object on the same drawing panel with the topleft corner specified by the parameters.

LFrame(Color[], String[]). Constructor for class LFrame

Creates a new legend frame.

M

max_data. Variable in class AlgThread

Size of the data set appropriate for algorighm animation.

move(int, int). Method in class ComBox

Move the top left position of the commentary box.

move(int, int). Method in interface DrawingObj

This method repositions the drawing object to the new location specified by the paramters.

move(int, int). Method in class IntMatrix

Move the matrix to the position specified with reference to the top left corner.

move(int, int). Method in class Legend

Move the object to the position as specified by the parameter.

move(int, int). Method in class Node

Move the node and all its branches based on the parameters.

move(int, int). Method in class ShadowLabel

Move this shadow label to the new position with its bottom left corner specified by the paramters.

moveNode(int, int). Method in class Node

Move the tree starting with node dx pixels to the right and dy pixels down.

N

Node(). Constructor for class Node

Create a new left node with weight 0.

Node(int). Constructor for class Node

Create a new leaf node with the specified weight.

Node(Node). Constructor for class Node

Create a node with the left node as set and weight of the current node set to 0.

Node(Node, Node). Constructor for class Node

Create a node with the left and right child nodes specified and the weight of the current node is the sum of the child node.

Node(String). Constructor for class Node

Create a new leaf node with 0 weight and label as specified.

Node(String, int). Constructor for class Node

Create a new leaf node with label and weight as specified in the parameters.

numOccupied(). Method in class TableCanvas

Get the number of rows in the table where the contents are non-null object.

numOccupied(). Method in class TablePanel

Pass the method call to the corresponding TableCanvas, which gets the number of rows in the table where the contents are non-null objects.

O

occupied(int). Method in class TableCanvas

Check if a particular row in the table has a non-null object.

occupied(int). Method in class TablePanel

Pass the method call to the corresponding TableCanvas, which checks if a particular row in the table has a non-null object.

P

paint(Graphics). Method in class DrawingPanel

Method to draw objects on the drawing panel.

paint(Graphics). Method in class Histogram

Method to draw objects on the histogram panel.

paint(Graphics). Method in class ImageButton

Method to draw image on the button

paint(Graphics). Method in class TableCanvas

Method to draw the table canvas.

paint(Graphics). Method in class TextPanel

This method print the source code starting from the first line specified by setStart(int) on the text panel.

preferredSize(). Method in class AlgAnimFrame

Returns the preferred size of the frame.

preferredSize(). Method in class ImageButton

Specify the dimension of the button.

preferredSize(). Method in class LFrame

Returns the dimension of the window when probed by the window manager.

preferredSize(). Method in class TableCanvas

Define the default size of the table.

preferredSize(). Method in class TextFrame

Return the preferred size of the frame.

print(Graphics). Method in class ImageButton

Method to draw image on the button

printMatrix(). Method in class IntMatrix

Print out the contents of the matrix to the stdout.

R

redraw(). Method in class DrawingPanel

Calls repaint() followed by delay().

refreshButtons(). Method in class ControlPanel

Perform a repaint() on each of the image buttons.

removeCom(ComBox). Method in class DrawingPanel

Remove the commentary box.

removeObj(DrawingObj). Method in class DrawingPanel

Remove a drawing object which matches the parameter.

restoreAll(). Method in class IntMatrix

Restore all previously highlighted element of the matrix (black and gray).

restoreDrawingPanel(). Method in class AlgAnimFrame

Restore the drawing panel at the end of the animation or during initialization.

restoreDrawingPanel(). Method in class AlgThread

Restore the drawing panel at the beginning or the end of each simulation.

restoreHighlight(int, int). Method in class IntMatrix

Restore the element which was highlighted using Color.black.

restoreHighlight2(int, int). Method in class IntMatrix

Restore the element which was highlighted using Color.gray.

restoreRow(). Method in class TableCanvas

This method is used to restore any highlighted row.

restoreRow(). Method in class TablePanel

Pass the method call to the corresponding TableCanvas, which restores any highlighted row.

run(). Method in class AlgThread

This method is invoked when the Thread class start() method is called.

S

scroll2posn(int). Method in class TablePanel

Scroll the display window of the table to shown the row specified by the parameter.

setAnimStep(int). Method in class DrawingPanel

Set the animation step, i.e.

setBackground(Color). Method in class ComBox

Set the background color of the commentary box.

setColLabels(String[]). Method in class IntMatrix

Set a label to each column of the matrix based on the array of String passed in as the parameter.

setColor(Color). Method in class ComBox

Set the text color of the commentary box.

setColor(Color). Method in class ShadowLabel

Set the text color of the drawing object.

setColor(Color, Color). Method in class IntMatrix

Set the foreground and background color for each element of the matrix.

setDelay(int). Method in class AlgAnimFrame

Set the delay for highlighting text.

setDelay(int). Method in class AlgThread

Sets the delay between each animation step.

setDelay(int). Method in class DrawingPanel

Set the delay duration between animation update.

setDepth(int). Method in class Node

Sets the depth of this node corresponding to the root node of the tree.

setDiag(int[]). Method in class IntMatrix

Set the value for each element on the main diagonal based on the array passed in as the parameter.

setDimension(Dimension). Method in class AlgAnimFrame

Sets the size of the frame.

setDimension(int, int). Method in class LFrame

Set the dimension of the legend window.

setDisable(). Method in class ImageButton

Disable the image button and set the current image to imageFileDisable.gif.

setDrawingPanel(DrawingPanel). Method in class AlgAnimFrame

Sets the drawing panel which is cast to its super class Panel.

setDrawingPanel(DrawingPanel). Method in class TablePanel

Set the parent panel where this table panel is going to reside.

setElem(int, int, int). Method in class IntMatrix

Assign a new value to the entry specified by the parameters.

setEnable(). Method in class ImageButton

Enable the image button and set the current image to imageFile.gif

setHighlight(int, int). Method in class IntMatrix

Highlight an element of the matrix, colouring it to black.

setHighlight2(int, int). Method in class IntMatrix

Highlight an element of the matrix, colouring it to gray.

setLabel(String). Method in class Node

Set the label of this node.

setLeftNode(Node). Method in class Node

Link the left branch of this node to the node passed in as the parameter.

setLT(int). Method in class IntMatrix

Assign a value to all elements to the left hand side of the main diagonal (exclusive).

setNoAnim(boolean). Method in class DrawingPanel

Set if the animation is disable.

setRightNode(Node). Method in class Node

Link the right branch of this node to the node passed in as the parameter.

setRowLabels(String[]). Method in class IntMatrix

Set a label to each row of the matrix based on the array of String passed in as the parameter.

setSkip(boolean). Method in class AlgAnimFrame

Sets the attribute which indicate if the skip execution mode is current.

setSkip(boolean). Method in class DrawingPanel

Set if the animation is in the 'SKIP' .

setStart(int). Method in class TableCanvas

Set the starting row, which will be displayed by the table.

setStart(int). Method in class TextPanel

Set the first line to display.

setStep(boolean). Method in class AlgAnimFrame

Sets the attribute which indicate if the step execution mode is current.

setTableEntry(Object, int). Method in class TableCanvas

Set the object specified by the first parameter to the table row defined by the second parameter.

setTableEntry(Object, int). Method in class TablePanel

Pass the method call to the corresponding TableCanvas, which sets the object specified by the first parameter to the table row defined by the second parameter.

setTableSize(int). Method in class TableCanvas

This method is called to set the size of the table and hence rescale the scrollbar on the panel it resides in.

setTableSize(int). Method in class TablePanel

Pass the method call to the corresponding TableCanvas, which sets the size of the table and hence rescale the scrollbar.

setText(int, String). Method in class AlgAnimFrame

Sets the text string to be displayed on a specific text field on the commentary panel return from getComPanel.

setText(int, String). Method in class ComPanel

This method set the text string on the text label specified by the parameters.

setText(String). Method in class ComBox

Set the text string to be displayed on the commentary box.

setText(String). Method in class ShadowLabel

Set the text string for this drawing object.

setTitle(String). Method in class Histogram

Set a title for the histogram.

setTitle(String). Method in class IntMatrix

Set a title to the matrix.

setTopLeft(int, int). Method in class ComBox

Set the top left position of the commentary box.

setValueXY(int, int). Method in class Histogram

Set the Y value for the vertical bar at the specified X position.

setWeight(int). Method in class Node

Set the weight of this node.

setX(int). Method in class Node

Sets the x coordinate of the top-left corner of the node

setXLabel(String). Method in class Histogram

Set a title for the x-axis.

setXMax(int). Method in class Histogram

Set the maximum value for the x-axis of the histogram.

setXMin(int). Method in class Histogram

Set the minimum value for the x-axis of the histogram.

setXStep(int). Method in class Histogram

Set the incremental step for the x-axis of the histogram.

setY(int). Method in class Node

Sets the y coordinate of the top-left corner of the node

setYLabel(String). Method in class Histogram

Set a title for the y-axis of the histogram.

setYMax(int). Method in class Histogram

Set the maximum value for the y-axis of the histogram.

setYMin(int). Method in class Histogram

Set the minimum value for the y-axis of the histogram.

setYStep(int). Method in class Histogram

Set the incremental step for the y-axis.

ShadowLabel(String). Constructor for class ShadowLabel

Construct a new shadow label with the initial text string as specified by the parameter.

shortDelay(). Method in class DrawingPanel

Causing a short delay of 1/3 of the normal delay duration.

start_button. Variable in class AlgAnimApp

A awt button to bring up a frame.

startAlg(). Method in class AlgAnimFrame

Start the animation algorithm if the run or step button is pressed.

T

TableCanvas(TablePanel). Constructor for class TableCanvas

Constructor method of the TableCanvas class.

TablePanel(int). Constructor for class TablePanel

Create a panel with a table canvas and a scrollbar to the east of the table canvas.

tableSize(). Method in class TableCanvas

Get the maximum size of the table (including all null and non-null objects).

tableSize(). Method in class TablePanel

Pass the method call to the corresponding TableCanvas, which gets the maximum size of the table.

TextFrame(URL). Constructor for class TextFrame

Construct a text frame and initialize the text panel to be added to the text frame.

TextPanel(String). Constructor for class TextPanel

Creates a text panel based on the source file specified in the String passed in as the parameter.

TextPanel(URL). Constructor for class TextPanel

Creates a text frame based on the URL specified by the parameter.

U

update(Graphics). Method in class DrawingPanel

This method is invoked when the repaint() method is called.

update(Graphics). Method in class Histogram

This method is invoked when the repaint() method is called.

update(Graphics). Method in class ImageButton

This method is invokes when the repaint method is called.

update(Graphics). Method in class TableCanvas

This method is invoked by the display manager when the repaint() method of the panel is called.

update(Graphics). Method in class TextPanel

This method is invoked when the repaint() method of the parent class is called.

W

waitSkip(). Method in class AlgAnimFrame

This method is called when the skip execution mode is used.

waitSkip(). Method in class AlgThread

This method is to be placed after the line where the fast forward function is to be performed.

waitStep(). Method in class AlgAnimFrame

This method is called when the step execution mode is used.

width. Variable in class LFrame

The dimension of the frame in the number of pixels.