algoanim.animalscript
Class AnimalStringMatrixGenerator

java.lang.Object
  extended by algoanim.primitives.generators.Generator
      extended by algoanim.animalscript.AnimalGenerator
          extended by algoanim.animalscript.AnimalStringMatrixGenerator
All Implemented Interfaces:
GeneratorInterface, StringMatrixGenerator

public class AnimalStringMatrixGenerator
extends AnimalGenerator
implements StringMatrixGenerator

Version:
0.4 2007-04-04
Author:
Dr. Guido Roessling (roessling@acm.org>
See Also:
StringMatrixGenerator

Field Summary
 
Fields inherited from class algoanim.primitives.generators.Generator
lang
 
Constructor Summary
AnimalStringMatrixGenerator(AnimalScript as)
           
 
Method Summary
 void create(StringMatrix aMatrix)
          Creates the originating script code for a given StringMatrix, due to the fact that before a primitive can be worked with it has to be defined and made known to the script language.
 void highlightCell(StringMatrix intMatrix, int row, int col, Timing offset, Timing duration)
          Highlights the array cell at a given position after a distinct offset of an StringMatrix.
 void highlightCellColumnRange(StringMatrix intMatrix, int row, int startCol, int endCol, Timing offset, Timing duration)
          Highlights a range of array cells of an StringMatrix.
 void highlightCellRowRange(StringMatrix intMatrix, int startRow, int endRow, int col, Timing offset, Timing duration)
          Highlights a range of array cells of an StringMatrix.
 void highlightElem(StringMatrix intMatrix, int row, int col, Timing offset, Timing duration)
          Highlights the array element of an StringMatrix at a given position after a distinct offset.
 void highlightElemColumnRange(StringMatrix intMatrix, int row, int startCol, int endCol, Timing offset, Timing duration)
          Highlights a range of array elements of an StringMatrix.
 void highlightElemRowRange(StringMatrix intMatrix, int startRow, int endRow, int col, Timing offset, Timing duration)
          Highlights a range of array elements of an StringMatrix.
 void put(StringMatrix intMatrix, int row, int col, java.lang.String what, Timing delay, Timing duration)
          Inserts an int at certain position in the given StringMatrix.
 void swap(StringMatrix intMatrix, int sourceRow, int sourceCol, int targetRow, int targetCol, Timing delay, Timing duration)
          Swaps to values in a given StringMatrix.
 void unhighlightCell(StringMatrix intMatrix, int row, int col, Timing offset, Timing duration)
          Unhighlights the array cell of an StringMatrix at a given position after a distinct offset.
 void unhighlightCellColumnRange(StringMatrix intMatrix, int row, int startCol, int endCol, Timing offset, Timing duration)
          Unhighlights a range of array cells of an StringMatrix.
 void unhighlightCellRowRange(StringMatrix intMatrix, int startRow, int endRow, int col, Timing offset, Timing duration)
          Unhighlights a range of array cells of an StringMatrix.
 void unhighlightElem(StringMatrix intMatrix, int row, int col, Timing offset, Timing duration)
          Unhighlights the array element of an StringMatrix at a given position after a distinct offset.
 void unhighlightElemColumnRange(StringMatrix intMatrix, int row, int startCol, int endCol, Timing offset, Timing duration)
          Unhighlights a range of array elements of an StringMatrix.
 void unhighlightElemRowRange(StringMatrix intMatrix, int row, int startCol, int endCol, Timing offset, Timing duration)
          Unhighlights a range of array elements of an StringMatrix.
 
Methods inherited from class algoanim.animalscript.AnimalGenerator
addBooleanOption, addBooleanSwitch, addColorOption, addColorOption, addFontOption, addFontOption, addIntOption, addWithTiming, changeColor, exchange, hide, makeColorDef, makeColorDef, makeDisplayOptionsDef, makeDisplayOptionsDef, makeDurationTimingDef, makeHiddenDef, makeNodeDef, makeOffsetTimingDef, moveBy, moveTo, moveVia, rotate, rotate, show
 
Methods inherited from class algoanim.primitives.generators.Generator
getLanguage, isNameUsed, isValidDirection
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface algoanim.primitives.generators.GeneratorInterface
changeColor, exchange, getLanguage, hide, moveBy, moveTo, moveVia, rotate, rotate, show
 

Constructor Detail

AnimalStringMatrixGenerator

public AnimalStringMatrixGenerator(AnimalScript as)
Parameters:
as - the associated Language object.
Method Detail

create

public void create(StringMatrix aMatrix)
Description copied from interface: StringMatrixGenerator
Creates the originating script code for a given StringMatrix, due to the fact that before a primitive can be worked with it has to be defined and made known to the script language.

Specified by:
create in interface StringMatrixGenerator
Parameters:
aMatrix - the StringMatrix for which the initiate script code shall be created.
See Also:
#create(algoanim.primitives.StringMatrix)

put

public void put(StringMatrix intMatrix,
                int row,
                int col,
                java.lang.String what,
                Timing delay,
                Timing duration)
Description copied from interface: StringMatrixGenerator
Inserts an int at certain position in the given StringMatrix.

Specified by:
put in interface StringMatrixGenerator
Parameters:
intMatrix - the StringMatrix in which to insert the value.
row - the row where the value shall be inserted.
col - the column where the value shall be inserted.
what - the String value to insert.
delay - the time to wait until the operation shall be performed.
duration - the duration of the operation.
See Also:
#put( algoanim.primitives.StringMatrix, int, int, String, algoanim.util.Timing, algoanim.util.Timing)

swap

public void swap(StringMatrix intMatrix,
                 int sourceRow,
                 int sourceCol,
                 int targetRow,
                 int targetCol,
                 Timing delay,
                 Timing duration)
Description copied from interface: StringMatrixGenerator
Swaps to values in a given StringMatrix.

Specified by:
swap in interface StringMatrixGenerator
Parameters:
intMatrix - the StringMatrix in which to swap the two indizes.
sourceRow - the row of the first value to be swapped.
sourceCol - the column of the first value to be swapped.
targetRow - the row of the second value to be swapped.
targetCol - the column of the second value to be swapped.
delay - the time to wait until the operation shall be performed.
duration - the duration of the operation.
See Also:
StringMatrixGenerator.swap( algoanim.primitives.StringMatrix, int, int, int, int, algoanim.util.Timing, algoanim.util.Timing)

highlightCell

public void highlightCell(StringMatrix intMatrix,
                          int row,
                          int col,
                          Timing offset,
                          Timing duration)
Description copied from interface: StringMatrixGenerator
Highlights the array cell at a given position after a distinct offset of an StringMatrix.

Specified by:
highlightCell in interface StringMatrixGenerator
row - the row of the cell to highlight.
col - the column of the cell to highlight.
offset - [optional] the offset after which the operation shall be started.
duration - [optional] the duration this operation lasts.
See Also:
#highlightCell(StringMatrix, int, int, algoanim.util.Timing, algoanim.util.Timing)

highlightCellColumnRange

public void highlightCellColumnRange(StringMatrix intMatrix,
                                     int row,
                                     int startCol,
                                     int endCol,
                                     Timing offset,
                                     Timing duration)
Description copied from interface: StringMatrixGenerator
Highlights a range of array cells of an StringMatrix.

Specified by:
highlightCellColumnRange in interface StringMatrixGenerator
row - the row of the interval to highlight.
startCol - the start column of the interval to highlight.
endCol - the end column of the interval to highlight.
offset - [optional] the offset after which the operation shall be started.
duration - [optional] the duration this operation lasts.
See Also:
#highlightCellColumnRange( StringMatrix, int, int, int, algoanim.util.Timing, algoanim.util.Timing)

highlightCellRowRange

public void highlightCellRowRange(StringMatrix intMatrix,
                                  int startRow,
                                  int endRow,
                                  int col,
                                  Timing offset,
                                  Timing duration)
Description copied from interface: StringMatrixGenerator
Highlights a range of array cells of an StringMatrix.

Specified by:
highlightCellRowRange in interface StringMatrixGenerator
startRow - the start row of the interval to highlight.
endRow - the end row of the interval to highlight.
col - the column of the interval to highlight.
offset - [optional] the offset after which the operation shall be started.
duration - [optional] the duration this operation lasts.
See Also:
#highlightCellRowRange( StringMatrix, int, int, int, algoanim.util.Timing, algoanim.util.Timing)

highlightElem

public void highlightElem(StringMatrix intMatrix,
                          int row,
                          int col,
                          Timing offset,
                          Timing duration)
Description copied from interface: StringMatrixGenerator
Highlights the array element of an StringMatrix at a given position after a distinct offset.

Specified by:
highlightElem in interface StringMatrixGenerator
Parameters:
intMatrix - the StringMatrix to work on.
row - the row of the element to highlight.
col - the column of the element to highlight.
offset - [optional] the offset after which the operation shall be started.
duration - [optional] the duration this operation lasts.
See Also:
#highlightElem( StringMatrix, int, int, algoanim.util.Timing, algoanim.util.Timing)

highlightElemColumnRange

public void highlightElemColumnRange(StringMatrix intMatrix,
                                     int row,
                                     int startCol,
                                     int endCol,
                                     Timing offset,
                                     Timing duration)
Description copied from interface: StringMatrixGenerator
Highlights a range of array elements of an StringMatrix.

Specified by:
highlightElemColumnRange in interface StringMatrixGenerator
Parameters:
intMatrix - the StringMatrix to work on.
row - the row of the interval to highlight.
startCol - the start of the column interval to highlight.
endCol - the end of the column interval to highlight.
offset - [optional] the offset after which the operation shall be started.
duration - [optional] the duration this operation lasts.
See Also:
#highlightElemColumnRange( StringMatrix, int, int, int, algoanim.util.Timing, algoanim.util.Timing)

highlightElemRowRange

public void highlightElemRowRange(StringMatrix intMatrix,
                                  int startRow,
                                  int endRow,
                                  int col,
                                  Timing offset,
                                  Timing duration)
Description copied from interface: StringMatrixGenerator
Highlights a range of array elements of an StringMatrix.

Specified by:
highlightElemRowRange in interface StringMatrixGenerator
Parameters:
intMatrix - the StringMatrix to work on.
startRow - the start of the row interval to highlight.
endRow - the end of the row interval to highlight.
col - the column interval to highlight.
offset - [optional] the offset after which the operation shall be started.
duration - [optional] the duration this operation lasts.
See Also:
#highlightElemRowRange( StringMatrix, int, int, int, algoanim.util.Timing, algoanim.util.Timing)

unhighlightCell

public void unhighlightCell(StringMatrix intMatrix,
                            int row,
                            int col,
                            Timing offset,
                            Timing duration)
Description copied from interface: StringMatrixGenerator
Unhighlights the array cell of an StringMatrix at a given position after a distinct offset.

Specified by:
unhighlightCell in interface StringMatrixGenerator
Parameters:
intMatrix - the StringMatrix to work on.
row - the row of the cell to unhighlight.
col - the column of the cell to unhighlight.
offset - [optional] the offset after which the operation shall be started.
duration - [optional] the duration this operation lasts.
See Also:
#unhighlightCell( StringMatrix, int, int, algoanim.util.Timing, algoanim.util.Timing)

unhighlightCellColumnRange

public void unhighlightCellColumnRange(StringMatrix intMatrix,
                                       int row,
                                       int startCol,
                                       int endCol,
                                       Timing offset,
                                       Timing duration)
Description copied from interface: StringMatrixGenerator
Unhighlights a range of array cells of an StringMatrix.

Specified by:
unhighlightCellColumnRange in interface StringMatrixGenerator
row - the row of the interval to highlight.
startCol - the start column of the interval to highlight.
endCol - the end column of the interval to highlight.
offset - [optional] the offset after which the operation shall be started.
duration - [optional] the duration this operation lasts.
See Also:
#unhighlightCell( StringMatrix, int, int, algoanim.util.Timing, algoanim.util.Timing)

unhighlightCellRowRange

public void unhighlightCellRowRange(StringMatrix intMatrix,
                                    int startRow,
                                    int endRow,
                                    int col,
                                    Timing offset,
                                    Timing duration)
Description copied from interface: StringMatrixGenerator
Unhighlights a range of array cells of an StringMatrix.

Specified by:
unhighlightCellRowRange in interface StringMatrixGenerator
startRow - the start row of the interval to highlight.
endRow - the end row of the interval to highlight.
col - the column of the interval to highlight.
offset - [optional] the offset after which the operation shall be started.
duration - [optional] the duration this operation lasts.
See Also:
#unhighlightCell( StringMatrix, int, int, algoanim.util.Timing, algoanim.util.Timing)

unhighlightElem

public void unhighlightElem(StringMatrix intMatrix,
                            int row,
                            int col,
                            Timing offset,
                            Timing duration)
Description copied from interface: StringMatrixGenerator
Unhighlights the array element of an StringMatrix at a given position after a distinct offset.

Specified by:
unhighlightElem in interface StringMatrixGenerator
Parameters:
intMatrix - the StringMatrix to work on.
row - the row of the element to unhighlight.
col - the column of the element to unhighlight.
offset - [optional] the offset after which the operation shall be started.
duration - [optional] the duration this operation lasts.
See Also:
#unhighlightElem( StringMatrix, int, int, algoanim.util.Timing, algoanim.util.Timing)

unhighlightElemColumnRange

public void unhighlightElemColumnRange(StringMatrix intMatrix,
                                       int row,
                                       int startCol,
                                       int endCol,
                                       Timing offset,
                                       Timing duration)
Description copied from interface: StringMatrixGenerator
Unhighlights a range of array elements of an StringMatrix.

Specified by:
unhighlightElemColumnRange in interface StringMatrixGenerator
Parameters:
intMatrix - the StringMatrix to work on.
row - the row of the interval to unhighlight.
startCol - the start of the column interval to unhighlight.
endCol - the end of the column interval to unhighlight.
offset - [optional] the offset after which the operation shall be started.
duration - [optional] the duration this operation lasts.
See Also:
#unhighlightElemColumnRange( StringMatrix, int, int, int, algoanim.util.Timing, algoanim.util.Timing)

unhighlightElemRowRange

public void unhighlightElemRowRange(StringMatrix intMatrix,
                                    int row,
                                    int startCol,
                                    int endCol,
                                    Timing offset,
                                    Timing duration)
Description copied from interface: StringMatrixGenerator
Unhighlights a range of array elements of an StringMatrix.

Specified by:
unhighlightElemRowRange in interface StringMatrixGenerator
Parameters:
intMatrix - the StringMatrix to work on.
row - the start row of the interval to unhighlight.
startCol - the end row of the interval to unhighlight.
endCol - the column interval to unhighlight.
offset - [optional] the offset after which the operation shall be started.
duration - [optional] the duration this operation lasts.
See Also:
#unhighlightElemRowRange( StringMatrix, int, int, int, algoanim.util.Timing, algoanim.util.Timing)