Class IPAMapGridContainer

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

ca.phon.ipamap2.IPAMapGridContainer

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, Scrollable

public class IPAMapGridContainer
extends JPanel
implements Scrollable

Container for IPAMapGrids.

See Also:

• Serialized Form

Nested Class Summary

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

JPanel.AccessibleJPanel

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

JComponent.AccessibleJComponent

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields inherited from class javax.swing.JComponent

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

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	Description
IPAMapGridContainer()

Method Summary

Modifier and Type	Method	Description
void	addCellMouseListener(IPAMapGridMouseListener listener)
void	addCellSelectionListener(IPAMapCellSelectionListener listener)
void	addDefaultGrids()	Adds all default Grids found in the ipamap.xml layout file.
Tuple<JButton, IPAMapGrid>	addGrid(Grid ipaGrid)	Add Grid to container.
void	fireCellClicked(Cell cell, MouseEvent me)
void	fireCellEntered(Cell cell, MouseEvent me)
void	fireCellExited(Cell cell, MouseEvent me)
void	fireCellPressed(Cell cell, MouseEvent me)
void	fireCellReleased(Cell cell, MouseEvent me)
void	fireCellSelectionChanged(IPAMapGrid grid, int cellIdx, boolean selected)
Predicate<Cell>	getCellFilter()
IPAMapGridMouseListener[]	getCellMouseListeners()
IPAMapCellRenderer	getCellRenderer()
JPanel	getMapGridPanel(IPAMapGrid mapGrid)	Return the panel displayed above the given grid.
Dimension	getPreferredScrollableViewportSize()
int	getScrollableBlockIncrement(Rectangle visibleRect, int orientation, int direction)
boolean	getScrollableTracksViewportHeight()
boolean	getScrollableTracksViewportWidth()
int	getScrollableUnitIncrement(Rectangle visibleRect, int orientation, int direction)
List<Cell>	getSelectedCells()	Return an unmodifiable list of selected Cells
void	invertSelection()
boolean	isGridVisible(IPAMapGrid mapGrid)
boolean	isGridVisible(String gridName)	Is the given section visible
boolean	isSelectionEnabled()
void	removeCellMouseListener(IPAMapGridMouseListener listener)
void	removeCellSelecitonListener(IPAMapCellSelectionListener listener)
void	setCellFilter(Predicate<Cell> filter)
void	setCellRenderer(IPAMapCellRenderer cellRenderer)
void	setFont(Font font)
void	setGridVisible(IPAMapGrid mapGrid, boolean visible)
void	setGridVisible(String gridName, boolean visible)
void	setSelectionEnabled(boolean selectionEnabled)

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, 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, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, 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, 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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, 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

Constructor Details

IPAMapGridContainer

public IPAMapGridContainer()

Method Details

addDefaultGrids

public void addDefaultGrids()

Adds all default Grids found in the ipamap.xml layout file.

setFont

public void setFont(Font font)

Overrides:

setFont in class JComponent

addGrid

public Tuple<JButton, IPAMapGrid> addGrid(Grid ipaGrid)

Add Grid to container. The method creates a new toggle button and IPAMapGrid component and returns them in a Tuple. The new components are added to the container in a vertical layout.

Parameters:

ipaGrid -

Returns:

getMapGridPanel

public JPanel getMapGridPanel(IPAMapGrid mapGrid)

Return the panel displayed above the given grid. The returned panel has a BorderLayout with the togglebutton in the center position.

Parameters:

mapGrid -

Returns:

panel or null

isSelectionEnabled

public boolean isSelectionEnabled()

setSelectionEnabled

public void setSelectionEnabled(boolean selectionEnabled)

addCellSelectionListener

public void addCellSelectionListener(IPAMapCellSelectionListener listener)

removeCellSelecitonListener

public void removeCellSelecitonListener(IPAMapCellSelectionListener listener)

fireCellSelectionChanged

public void fireCellSelectionChanged(IPAMapGrid grid,
 int cellIdx,
 boolean selected)

getSelectedCells

public List<Cell> getSelectedCells()

Return an unmodifiable list of selected Cells

Returns:

list of selected cells

invertSelection

public void invertSelection()

isGridVisible

public boolean isGridVisible(String gridName)

Is the given section visible

Parameters:

gridName -

Returns:

true if section is visible

setGridVisible

public void setGridVisible(String gridName,
 boolean visible)

isGridVisible

public boolean isGridVisible(IPAMapGrid mapGrid)

setGridVisible

public void setGridVisible(IPAMapGrid mapGrid,
 boolean visible)

addCellMouseListener

public void addCellMouseListener(IPAMapGridMouseListener listener)

removeCellMouseListener

public void removeCellMouseListener(IPAMapGridMouseListener listener)

getCellMouseListeners

public IPAMapGridMouseListener[] getCellMouseListeners()

getCellFilter

public Predicate<Cell> getCellFilter()

setCellFilter

public void setCellFilter(Predicate<Cell> filter)

getCellRenderer

public IPAMapCellRenderer getCellRenderer()

setCellRenderer

public void setCellRenderer(IPAMapCellRenderer cellRenderer)

fireCellPressed

public void fireCellPressed(Cell cell,
 MouseEvent me)

fireCellReleased

public void fireCellReleased(Cell cell,
 MouseEvent me)

fireCellClicked

public void fireCellClicked(Cell cell,
 MouseEvent me)

fireCellEntered

public void fireCellEntered(Cell cell,
 MouseEvent me)

fireCellExited

public void fireCellExited(Cell cell,
 MouseEvent me)

getPreferredScrollableViewportSize

public Dimension getPreferredScrollableViewportSize()

Specified by:

getPreferredScrollableViewportSize in interface Scrollable

getScrollableUnitIncrement

public int getScrollableUnitIncrement(Rectangle visibleRect,
 int orientation,
 int direction)

Specified by:

getScrollableUnitIncrement in interface Scrollable

getScrollableBlockIncrement

public int getScrollableBlockIncrement(Rectangle visibleRect,
 int orientation,
 int direction)

Specified by:

getScrollableBlockIncrement in interface Scrollable

getScrollableTracksViewportWidth

public boolean getScrollableTracksViewportWidth()

Specified by:

getScrollableTracksViewportWidth in interface Scrollable

getScrollableTracksViewportHeight

public boolean getScrollableTracksViewportHeight()

Specified by:

getScrollableTracksViewportHeight in interface Scrollable