Class RhombDisplay

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

RhombDisplay

All Implemented Interfaces:

java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

public class RhombDisplay
extends javax.swing.JPanel
implements java.awt.event.ActionListener

A class for drawing and modifying a patch of rhombs. The modifications happen when the user clicks on a trio of rhombs, which are an instance of a Hex. The rhombs in this Hex are then rotated, which changes the Hexes in this that can subsequently be modified.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	HEIGHT_BUFFER Extra space added at the top and bottom of a patch when determining the window size.
double	scale The scale that is used for drawing SimpleRhombs in this display.
static double	SCALE The default scale for drawing SimpleRhombs.
static int	WIDTH_BUFFER Extra space added at the left and right of a patch when determining the window size.

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

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
RhombDisplay(RhombBoundary r) Default Constructor.
RhombDisplay(RhombBoundary r, double scale) Constructor with custom scale for the SimpleRhombs.
RhombDisplay(RhombBoundary r, double scale, int w, int h) Constructor with custom dimensions for the window.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e) Print a gap-readable version of the underlying data structure if the print button is pressed.
void	click(java.util.List<Hex> l) Call this method whenever a Hex is clicked on.
static java.util.List<RhombDisplay>	displayList(java.util.List<RhombBoundary> rules, int paneWidth, int paneHeight) Take a List of RhombBoundaries and return a List of the corresponding RhombDisplays, all given the same scale, which is chosen in such a way as to make each one fit in a pane of the given dimensions.
void	flushButtons(java.util.List<Hex> l) Refresh the list of buttons that can be clicked in this.
RhombBoundary	getBoundary() Get the underlying data structure for this patch.
int	getHeight() Get the height of this.
java.awt.Dimension	getPreferredSize()
int	getWidth() Get the width of this.
int	getXMin() Get the minimum x-coordinate of any rhomb in this.
int	getYMin() Get the minimum y-coordinate of any rhomb in this.
void	paintComponent(java.awt.Graphics g) Draw this.
void	resetButtons() Clear all the buttons and create new ones from the RhombBoundary in this.
static void	setEditor(SubstitutionEditor e) Set the SubstitutionEditor to which all RhombDisplays point.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, 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, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, 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

WIDTH_BUFFER

public static final int WIDTH_BUFFER

Extra space added at the left and right of a patch when determining the window size.

See Also:

Constant Field Values

HEIGHT_BUFFER

public static final int HEIGHT_BUFFER

Extra space added at the top and bottom of a patch when determining the window size.

See Also:

Constant Field Values

SCALE

public static final double SCALE

The default scale for drawing SimpleRhombs.

See Also:

Constant Field Values

scale

public final double scale

The scale that is used for drawing SimpleRhombs in this display.

Constructor Detail

RhombDisplay

public RhombDisplay(RhombBoundary r)
             throws java.awt.HeadlessException

Default Constructor. Use the default SCALE and infer the window size from the contents of r, with WIDTH_BUFFER and HEIGHT_BUFFER added to the edges.

Parameters:

r - The underlying patch that this allows the user to edit.

Throws:

java.awt.HeadlessException

RhombDisplay

public RhombDisplay(RhombBoundary r,
            double scale,
            int w,
            int h)
             throws java.awt.HeadlessException

Constructor with custom dimensions for the window.

Parameters:

r - The underlying patch that this allows the user to edit.

scale - The factor by which the SimpleRhombs of r are scaled.

w - The width of this component.

h - The height of this component.

Throws:

java.awt.HeadlessException

RhombDisplay

public RhombDisplay(RhombBoundary r,
            double scale)
             throws java.awt.HeadlessException

Constructor with custom scale for the SimpleRhombs.

Parameters:

r - The underlying patch that this allows the user to edit.

scale - The factor by which the SimpleRhombs of r are scaled.

Throws:

java.awt.HeadlessException

Method Detail

click

public void click(java.util.List<Hex> l)

Call this method whenever a Hex is clicked on.

Parameters:

l - The Hexes that can be dragged after this click.

flushButtons

public void flushButtons(java.util.List<Hex> l)

Refresh the list of buttons that can be clicked in this.

Parameters:

l - A List of Hexes to add and remove. For each element of l, if this already has a corresponding button, then we remove it, otherwise we create such a button and add it.

resetButtons

public void resetButtons()

Clear all the buttons and create new ones from the RhombBoundary in this.

getWidth

public int getWidth()

Get the width of this.

Overrides:

getWidth in class javax.swing.JComponent

Returns:

The width of this.

getHeight

public int getHeight()

Get the height of this.

Overrides:

getHeight in class javax.swing.JComponent

Returns:

The height of this.

getXMin

public int getXMin()

Get the minimum x-coordinate of any rhomb in this.

Returns:

The minimum x-coordinate of any rhomb in this.

getYMin

public int getYMin()

Get the minimum y-coordinate of any rhomb in this.

Returns:

The minimum y-coordinate of any rhomb in this.

getBoundary

public RhombBoundary getBoundary()

Get the underlying data structure for this patch.

Returns:

The underlying data structure for this patch.

paintComponent

public void paintComponent(java.awt.Graphics g)

Draw this.

Overrides:

paintComponent in class javax.swing.JComponent

Parameters:

g - The graphis object on which we draw this.

getPreferredSize

public java.awt.Dimension getPreferredSize()

Overrides:

getPreferredSize in class javax.swing.JComponent

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Print a gap-readable version of the underlying data structure if the print button is pressed.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

See Also:

RhombBoundary.gapString()

setEditor

public static void setEditor(SubstitutionEditor e)

Set the SubstitutionEditor to which all RhombDisplays point. When a RhombDisplay is changed, this change will be reflected in the PatchDisplay of e.

Parameters:

e - All RhombDisplays will now point to e.

displayList

public static java.util.List<RhombDisplay> displayList(java.util.List<RhombBoundary> rules,
                                       int paneWidth,
                                       int paneHeight)

Take a List of RhombBoundaries and return a List of the corresponding RhombDisplays, all given the same scale, which is chosen in such a way as to make each one fit in a pane of the given dimensions.

Parameters:

rules - The RhombBoundaries we want to put into RhombDisplays.

paneWidth - The width of the pane in which we want each one to fit.

paneHeight - The height of the pane in which we want each one to fit.

Returns:

A List of RhombDisplays generated from rules, each one scaled to fit in a pane of dimensions paneWidth x paneHeight.