SortApp

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - java.awt.Panel
    - - de.weaut.sortDemo.SortApp

All Implemented Interfaces:

java.awt.event.MouseListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.lang.Runnable, java.util.EventListener, javax.accessibility.Accessible
```
public final class SortApp
extends java.awt.Panel
implements java.lang.Runnable, java.awt.event.MouseListener
```
Demo application for sorting algorithms.

An object of this class can demonstrate the working of any sorting algorithm by wrapping it as Panel and running it as application.

The concrete algorithm must be implemented by extending the embedded class SortApp.SortAlgorithm.

The original Applet as well as a bundle of implemented algorithms to show were mostly by James Gosling, whose original Copyright notice for sources SortItem.java (V.1.17f 95/04/10) and SortAlgorithm.java (V.1.6f 95/01/31) were preserved here. The sources have been modified by Albrecht Weinert since 2005 beyond recognition. In the mean time (starting ~2015) Applets have been finally killed by Oracle. Hence, the many years parallel support for being both Applet and Application has been dropped 2017.

Hints for handling: A mouse click on the image (the mouse release to be exact) will start the demo run of the sort algorithm named in the start parameter.
Additionally since April 2015:
Pressing the left mouse button: shuffle, middle button: leave state as is, and right button: reverse the array.

Starting as application: java de.weaut.sortDemo.SortApp BubbleSort

Copyright 2005, 2010, 2015, 2017 Albrecht Weinert

Version:

V.7, 31.03.2017

Author:

Albrecht Weinert

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SortApp.SortAlgorithm
An abstract sorting algorithm for demonstrations.
- Nested classes/interfaces inherited from class java.awt.Panel
  java.awt.Panel.AccessibleAWTPanel
- Nested classes/interfaces inherited from class java.awt.Container
  java.awt.Container.AccessibleAWTContainer
- Nested classes/interfaces inherited from class java.awt.Component
  java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Nested Classes
Modifier and Type	Class and Description
`static class`	`SortApp.SortAlgorithm` An abstract sorting algorithm for demonstrations.

Field Summary

Fields
Modifier and Type	Field and Description
`(package private) java.lang.String`	`algName` The algorithm's name.
`(package private) SortApp.SortAlgorithm`	`algorithm` Sorting algorithm (or null).
`(package private) int[]`	`arr` The array to be sorted.
`(package private) int`	`bApp` The frame's width.
`(package private) java.awt.Color`	`bgCol` Background colour.
`(package private) java.awt.image.BufferedImage`	`buffI`
`(package private) java.awt.Graphics`	`buGr`
`(package private) int`	`hApp` The frame's height.
`protected int`	`hLcke` Height of the gap between element markers in pixels.
`protected int`	`hStrich` Height of an element marker as horizontal line in pixels.
`(package private) int`	`lArr` The length of the array to be sorted.
`protected long`	`lenPau` Pause in ms for algorithm step display.
`(package private) int`	`obItem` Upper (last) action mark in the course of sorting.
`(package private) java.util.Random`	`rand`
`(package private) int`	`steps` The step counter.
`(package private) int`	`untItem` Lower (last) action mark in the course of sorting.

Fields inherited from class java.awt.Component
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors
Constructor and Description

SortApp(java.lang.String algName)
Constructor as Panel respectively application.

Constructors
Constructor and Description
`SortApp(java.lang.String algName)` Constructor as Panel respectively application.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int[]`	`getArr()` The array to be sorted.
`java.awt.Dimension`	`getMinimumSize()` Minimal size.
`java.awt.Dimension`	`getPreferredSize()` Preferred size.
`static void`	`main(java.lang.String[] args)` Start the sorting Demonstration as Java application.
`void`	`mouseClicked(java.awt.event.MouseEvent e)`
`void`	`mouseEntered(java.awt.event.MouseEvent e)`
`void`	`mouseExited(java.awt.event.MouseEvent e)`
`void`	`mousePressed(java.awt.event.MouseEvent e)` Mouse event.
`void`	`mouseReleased(java.awt.event.MouseEvent e)` Mouse event.
`void`	`paint(java.awt.Graphics g)` (Re-) paint the sorting array as pile of horizontal bars.
`void`	`pause(int obItem, int untItem)` Show the current state / step of the algorithm just working.
`(package private) boolean`	`provideArr()` Providing a new array and buffer, if necessary.
`void`	`run()` The sorting thread.
`(package private) void`	`scramble()` Providing the array to be sorted with shuffled (random) content.
`protected void`	`startSort()` Start the sorting demo.
`void`	`stop()` Sort demo stop.
`void`	`update(java.awt.Graphics g)` Update without clearing.

Methods inherited from class java.awt.Panel
addNotify, getAccessibleContext

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, isValidateRoot, layout, list, list, locate, minimumSize, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, revalidate, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - arr
```
int[] arr
```
    The array to be sorted.
    
    It will be provided in a length (>= 3) fitting the height of the Frame. The first setting will be shuffled. It will contain positive integers smaller than the Frame's width in pixels.
    
    The concrete algorithm has to sort it and must mark substantial steps by one of callback methods pause(int, int) etc.
  - obItem
```
int obItem
```
    Upper (last) action mark in the course of sorting.
    
    It will be displayed as red marking line; -1 means no display / no mark.
  - untItem
```
int untItem
```
    Lower (last) action mark in the course of sorting.
    
    It will be displayed as blue marking line; -1 means no display / no mark.
  - algName
```
java.lang.String algName
```
    The algorithm's name.
    
    It will be made by using the application's first start parameter. That will be suffixed by "Algorithm". A class of type SortApp.SortAlgorithm so named will be looked up in the same package (de.weaut.demos) as single file or in the application's .jar-File.
  - algorithm
```
SortApp.SortAlgorithm algorithm
```
    Sorting algorithm (or null).
  - hApp
```
int hApp
```
    The frame's height.
    
    Will actualised before re-shuffling.
    Minimal height 50.
  - bApp
```
int bApp
```
    The frame's width.
    
    Will actualised before re-shuffling.
    Minimal width 50.
  - lArr
```
int lArr
```
    The length of the array to be sorted.
    
    Will actualised before re-shuffling. If changed an new array arr will be provided accordingly.
    
    This length will be a function of bApp, hStrich and hLcke just to fill the frame's height but never less than 3.
    The implementors of sorting algorithms must not deal with shorter (or empty or null) arrays.
  - hStrich
```
protected int hStrich
```
    Height of an element marker as horizontal line in pixels.
    
    Allowed range: 2..15
    Default: 4
  - hLcke
```
protected int hLcke
```
    Height of the gap between element markers in pixels.
    
    Allowed range: 1..6
    Default: 3
  - lenPau
```
protected long lenPau
```
    Pause in ms for algorithm step display.
    
    default: 35
  - rand
```
java.util.Random rand
```
  - buffI
```
java.awt.image.BufferedImage buffI
```
  - buGr
```
java.awt.Graphics buGr
```
  - bgCol
```
java.awt.Color bgCol
```
    Background colour.
    
    default: a light gray
  - steps
```
int steps
```
    The step counter.
- Constructor Detail
  - SortApp
```
public SortApp(java.lang.String algName)
```
    Constructor as Panel respectively application.
- Method Detail
  - getArr
```
public final int[] getArr()
```
    The array to be sorted.
    
    It will be provided in a length (>= 3) fitting the height of the Frame. The first setting will be shuffled. It will contain positive integers smaller than the Frame's width in pixels.
    
    The concrete algorithm has to sort it and must mark substantial steps by one of callback methods pause(int, int) etc.
  - provideArr
```
boolean provideArr()
```
    Providing a new array and buffer, if necessary.
    
    The array to be sorted will be provided fitting the height of the Applet or frame (hApp), the lines (hStrich) and the gaps (hLcke) if not yet fitting.
    The array's length will be at least 3 even if the frame was made to small.
    
    Returns:
    
    true if the array has been newly made
  - scramble
```
void scramble()
```
    Providing the array to be sorted with shuffled (random) content.
    
    The array will be provided newly if necessary.
    It's elements will be set with values in the range 1 to (width - 1) in random order.
  - pause
```
public void pause(int obItem,
                  int untItem)
```
    Show the current state / step of the algorithm just working.
    
    If an concrete sorting algorithm is at work the array's actual state will be displayed and two elements respectively indices may be marked as to show the current state of work.
    lenPau ms pause will be made to view the state.
    
    Hint: The default of 30ms is (just) long enough to make a step recognisable and short enough not to make slow sorting algorithms too boring.
    
    This is the "call-back-" method for the abstract {link SortAlgorithm sorting algorithm}.
    
    Parameters:
    
    obItem - upper index or mark (red); or -1 for none
    
    untItem - lower index or mark (red); or -1 for none
  - paint
```
public void paint(java.awt.Graphics g)
```
    (Re-) paint the sorting array as pile of horizontal bars.
    
    Overrides:
    
    paint in class java.awt.Container
  - update
```
public void update(java.awt.Graphics g)
```
    Update without clearing.
    
    Delegates to paint(Graphics), which provides flicker free double buffering.
    
    Overrides:
    
    update in class java.awt.Container
  - run
```
public void run()
```
    The sorting thread.
    
    This is the working method for a running demo. On first run the concrete sorting algorithms implementation's class will be determined according to start parameter's value.
    An object of this class (extending SortApp.SortAlgorithm will be made and its method sort(int[]) be called.
    
    Specified by:
    
    run in interface java.lang.Runnable
  - stop
```
public void stop()
```
    Sort demo stop.
    
    Tries to stop a running sort demo.
  - startSort
```
protected final void startSort()
```
    Start the sorting demo.
    
    If no sorting demo (thread) is currently running, it will be started.
  - mouseReleased
```
public void mouseReleased(java.awt.event.MouseEvent e)
```
    Mouse event.
    
    The user released a mouse button within the Applet / frame.
    This will start the sorting demo if not yet running.
    
    Specified by:
    
    mouseReleased in interface java.awt.event.MouseListener
  - mousePressed
```
public void mousePressed(java.awt.event.MouseEvent e)
```
    Mouse event.
    
    The user clicked / pressed a mouse button within the frame.
    This will stop a running demo and shuffles (left button), reverses the array (right button) or leaves it as is (middle button).
    
    Specified by:
    
    mousePressed in interface java.awt.event.MouseListener
  - mouseEntered
```
public void mouseEntered(java.awt.event.MouseEvent e)
```
    Specified by:
    
    mouseEntered in interface java.awt.event.MouseListener
  - mouseExited
```
public void mouseExited(java.awt.event.MouseEvent e)
```
    Specified by:
    
    mouseExited in interface java.awt.event.MouseListener
  - mouseClicked
```
public void mouseClicked(java.awt.event.MouseEvent e)
```
    Specified by:
    
    mouseClicked in interface java.awt.event.MouseListener
  - getPreferredSize
```
public java.awt.Dimension getPreferredSize()
```
    Preferred size.
    
    Overrides:
    
    getPreferredSize in class java.awt.Container
    
    Returns:
    
    (500, 328).
  - getMinimumSize
```
public java.awt.Dimension getMinimumSize()
```
    Minimal size.
    
    Overrides:
    
    getMinimumSize in class java.awt.Container
    
    Returns:
    
    (300, 200)
  - main
```
public static void main(java.lang.String[] args)
```
    Start the sorting Demonstration as Java application.
    
    An object of this class SortApp will as a Panel be embedded in a Frame of original size 520 * 338 and initialised accordingly.
    Run by:
    javaw de.weaut.sortDemo.SortApp [AlgName [-option] [x y]]
    javaw -jar jarFile [AlgName [-option] [x y]]
    Examples:
    java de.weaut.sortDemo.SortApp QuickSort -small 40 15
    java -jar sortDemo.jar HeapSort
    Options:
    -small : height=202, width=300 instead of 520, 338
    Parameters x, y: frame's left upper corner position on screen
    The parameter AlgName (default RadixSort) will be prefixed and suffixed according to the schema de.weaut.demos.AlgNameAlgorithm.
    This must be a fully qualified name of a concrete class extending SortApp.SortAlgorithm. This class will be searched for in the class path or within this application's .jar-file.
    In that .jar a bundle of standard algorithms (most of them originally provided by James Gosling) are provided ready for demonstration:
    BidirectionalBubbleSort, FastQSort, QuickSort, ShellSort, BubbleSort, QubbleSort, CombSort11, HeapSort, RadixSort, EQSort, InsertionSort, SelectionSort, ExtraStorageMergeSort, MergeSort, ShakerSort
    
    Parameters:
    
    args - [0] : algorithm's short name, default RadixSort;
    optional parameters see above

Class SortApp

Nested Class Summary

Nested classes/interfaces inherited from class java.awt.Panel

Nested classes/interfaces inherited from class java.awt.Container

Nested classes/interfaces inherited from class java.awt.Component

Field Summary

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class java.awt.Panel

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

arr

obItem

untItem

algName

algorithm

hApp

bApp

lArr

hStrich

hLcke

lenPau

rand

buffI

buGr

bgCol

steps

Constructor Detail

SortApp

Method Detail

getArr

provideArr

scramble

pause

paint

update

run

stop

startSort

mouseReleased

mousePressed

mouseEntered

mouseExited

mouseClicked

getPreferredSize

getMinimumSize

main