kcl.waterloo.swing

Class GCGrid

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.jdesktop.swingx.JXPanel

kcl.waterloo.graphics.GJBasicPanel

kcl.waterloo.swing.GCGrid

All Implemented Interfaces:

java.awt.event.ComponentListener, java.awt.event.ContainerListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.awt.print.Printable, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible, javax.swing.Scrollable

public final class GCGrid
extends GJBasicPanel

GCGrid supports grids of graph containers. GCGrid uses a subclass of the SpringLayout to maintain the relative positions of the graph containers.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GCGrid.GridMenuAction

Nested classes/interfaces inherited from class kcl.waterloo.graphics.GJBasicPanel

GJBasicPanel.LocalTransferable

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Component.BaselineResizeBehavior

Field Summary

Fields inherited from class javax.swing.JComponent

TOOL_TIP_TEXT_KEY, 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.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
GCGrid() Default constructor.

Method Summary

Modifier and Type	Method and Description
java.awt.Component	add(java.awt.Component c) Add method that wraps the added component in a GCGridElement as required.
java.awt.Component	add(java.awt.Component c, double row, double column) Add method that wraps the added component in a GCGridElement as required.
java.awt.Component	add(java.awt.Component c, double row, double column, double width, double height) Add method that wraps the added component in a GCGridElement as required.
double[]	getDimensions()
java.util.ArrayList<GCGridElement>	getElements()
java.util.ArrayList<GCGridElement>	getElementsAt(double row, double column) Returns the grid element(s) located at the point {x=row, y=column} as an ArrayList.
GCGlassLayer	getGlassLayer() Returns the glass layer
javax.swing.JMenu	getGridMenu() Adds grid support to the context menu
SpringGridLayout	getLayout()
void	revalidate()
void	setGlassLayer(GCGlassLayer gl)

Methods inherited from class kcl.waterloo.graphics.GJBasicPanel

componentAdded, componentHidden, componentMoved, componentRemoved, componentResized, componentShown, getAllComponents, getID, getImage, getTransferable, getTransferable, isBackgroundPainted, isOnEDT, paintComponent, print, print, setBackgroundPainted, setID

Methods inherited from class org.jdesktop.swingx.JXPanel

getAlpha, getBackgroundPainter, getEffectiveAlpha, getPreferredScrollableViewportSize, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, isInheritAlpha, isPaintBorderInsets, paint, setAlpha, setBackgroundPainter, setInheritAlpha, setOpaque, setPaintBorderInsets, setScrollableHeightHint, setScrollableTracksViewportHeight, setScrollableTracksViewportWidth, setScrollableWidthHint

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, setUI, updateUI

Methods inherited from class javax.swing.JComponent

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

Methods inherited from class java.awt.Container

add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, contains, createImage, createImage, createVolatileImage, createVolatileImage, dispatchEvent, enable, enableInputMethods, 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, 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

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GCGrid

public GCGrid()

Default constructor. Creates a 1x1 gridDimensions

Method Detail

getGridMenu

public javax.swing.JMenu getGridMenu()

Adds grid support to the context menu

Returns:

getLayout

public SpringGridLayout getLayout()

Overrides:

getLayout in class java.awt.Container

add

public java.awt.Component add(java.awt.Component c)

Add method that wraps the added component in a GCGridElement as required.

Overrides:

add in class java.awt.Container

Parameters:

c - the component to add

Returns:

the added GCGridElement

add

public java.awt.Component add(java.awt.Component c,
                              double row,
                              double column)

Add method that wraps the added component in a GCGridElement as required.

Parameters:

c - the component to add

row - the target row

column - the target column

Returns:

the added GCGridElement

add

public java.awt.Component add(java.awt.Component c,
                              double row,
                              double column,
                              double width,
                              double height)

Add method that wraps the added component in a GCGridElement as required.

Parameters:

c - the component to add

row - the target row

column - the target column

width - the width of the component

height - the height of the component

Returns:

the added GCGridElement

getElementsAt

public java.util.ArrayList<GCGridElement> getElementsAt(double row,
                                                        double column)

Returns the grid element(s) located at the point {x=row, y=column} as an ArrayList. Note: Row and column are specified as doubles, and it is up to the user to ensure that the comparison for an exact match does not fail due to IEEE rounding errors.

Parameters:

row -

column -

Returns:

the element(s) as an ArrayList

getGlassLayer

public GCGlassLayer getGlassLayer()

Returns the glass layer

Returns:

the GCGlassLayer

setGlassLayer

public void setGlassLayer(GCGlassLayer gl)

getDimensions

public double[] getDimensions()

getElements

public java.util.ArrayList<GCGridElement> getElements()

revalidate

public void revalidate()

Overrides:

revalidate in class javax.swing.JComponent