Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> crosswire >> bible >> map >> [ view overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

org.crosswire.bible.map.view
Class MapperPane  

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.crosswire.bible.map.view.MapperPane

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.Scrollable, java.io.Serializable

---

public class MapperPane

extends javax.swing.JPanel

implements javax.swing.Scrollable

This is an Swing GUI interface to the BMap project.

Distribution Licence: Project B is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2 as published by the Free Software Foundation. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. The License is available on the internet here, by writing to Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA, Or locally at the Licence link below. The copyright to this program is held by it's authors.

Version:

D0.I0.T0

---

Nested Class Summary
(package private)  class	MapperPane.CustomMapListener           Sync the map and the table

 

Nested classes inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

 

Nested classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

 

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

 

Nested classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

 

Field Summary
private  MapperPane.CustomMapListener	cml           The map listener
private  boolean	lock_aspect           Do we force height and width to be the same
private  org.crosswire.bible.map.model.Map	map           The Map that we are viewing
private  VerseColor	versecolor           The VerseColorizer
private static int	X           constant for the X part
private static int	Y           constant for the Y part

 

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.Container

 

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

MapperPane()           Basic Constructor

MapperPane(org.crosswire.bible.map.model.Map map)           Basic Constructor

 

Method Summary
boolean	getLockAspectRation()           Do we force the height and width of this panel to be the same
org.crosswire.bible.map.model.Map	getMap()           Get the map being viewed
private  int[]	getPosition(int ord)           Get a (2D) position based on a verse ordinal
java.awt.Dimension	getPreferredScrollableViewportSize()           Get the preferred size of the viewport.
int	getScrollableBlockIncrement(java.awt.Rectangle rec, int bar, int dir)           Set the unit or block increment in pixels.
boolean	getScrollableTracksViewportHeight()           If we are is displayed in a JViewport, don't change its height when the viewports height changes.
boolean	getScrollableTracksViewportWidth()           If we are is displayed in a JViewport, don't change its width when the viewports width changes.
int	getScrollableUnitIncrement(java.awt.Rectangle rec, int bar, int dir)           Get the unit or block increment in pixels.
VerseColor	getVerseColor()           Get the way in which we color the map
void	paintComponent(java.awt.Graphics g)           Paint the map
void	setLockAspectRation(boolean lock_aspect)           Do we force the height and width of this panel to be the same
void	setMap(org.crosswire.bible.map.model.Map map)           Setup a new map to view
void	setSize(java.awt.Dimension x)           The size of this map public void reshape(int x, int y, int w, int h)
void	setVerseColor(VerseColor versecolor)           Set the way in which we color the map
private  int[]	translate(float[] orig)           Map a (0-1) float coordinate into the int based coordinate that we can paint with
private  int	translateX(float orig)           Map a (0-1) float width into the int based coordinate that we can paint with
private  int	translateY(float orig)           Map a (0-1) float height into the int based coordinate that we can paint with

 

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

 

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, 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, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, 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, 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

X

private static final int X

constant for the X part

See Also:

Constant Field Values

---

Y

private static final int Y

constant for the Y part

See Also:

Constant Field Values

---

map

private org.crosswire.bible.map.model.Map map

The Map that we are viewing

---

lock_aspect

private boolean lock_aspect

Do we force height and width to be the same

---

cml

private MapperPane.CustomMapListener cml

The map listener

---

versecolor

private VerseColor versecolor

The VerseColorizer

Constructor Detail

MapperPane

public MapperPane(org.crosswire.bible.map.model.Map map)

Basic Constructor

---

MapperPane

public MapperPane()

Basic Constructor

Method Detail

setMap

public void setMap(org.crosswire.bible.map.model.Map map)

Setup a new map to view

---

getMap

public org.crosswire.bible.map.model.Map getMap()

Get the map being viewed

---

setVerseColor

public void setVerseColor(VerseColor versecolor)

Set the way in which we color the map

---

getVerseColor

public VerseColor getVerseColor()

Get the way in which we color the map

---

setLockAspectRation

public void setLockAspectRation(boolean lock_aspect)

Do we force the height and width of this panel to be the same

---

getLockAspectRation

public boolean getLockAspectRation()

Do we force the height and width of this panel to be the same

---

paintComponent

public void paintComponent(java.awt.Graphics g)

Paint the map

---

getPosition

private int[] getPosition(int ord)

Get a (2D) position based on a verse ordinal

---

translate

private final int[] translate(float[] orig)

Map a (0-1) float coordinate into the int based coordinate that we can paint with

---

translateX

private final int translateX(float orig)

Map a (0-1) float width into the int based coordinate that we can paint with

---

translateY

private final int translateY(float orig)

Map a (0-1) float height into the int based coordinate that we can paint with

---

setSize

public void setSize(java.awt.Dimension x)

The size of this map public void reshape(int x, int y, int w, int h)

---

getScrollableUnitIncrement

public int getScrollableUnitIncrement(java.awt.Rectangle rec,
                                      int bar,
                                      int dir)

Get the unit or block increment in pixels. The Rectangle parameter is the bounds of the currently visible rectangle. The first int parameter is either SwingConstants.HORIZONTAL or SwingConstants.VERTICAL depending on what scroll bar the user clicked on. The second int parameter indicates which direction to scroll. A value less than 0 indicates up or left. A value greater than 0 indicates down or right.

Specified by:

getScrollableUnitIncrement in interface javax.swing.Scrollable

---

getScrollableBlockIncrement

public int getScrollableBlockIncrement(java.awt.Rectangle rec,
                                       int bar,
                                       int dir)

Set the unit or block increment in pixels. The Rectangle parameter is the bounds of the currently visible rectangle. The first int parameter is either SwingConstants.HORIZONTAL or SwingConstants.VERTICAL depending on what scroll bar the user clicked on. The second int parameter indicates which direction to scroll. A value less than 0 indicates up or left. A value greater than 0 indicates down or right.

Specified by:

getScrollableBlockIncrement in interface javax.swing.Scrollable

---

getPreferredScrollableViewportSize

public java.awt.Dimension getPreferredScrollableViewportSize()

Get the preferred size of the viewport. This allows the client to influence the size of the viewport in which it will be displayed. If the viewport size is unimportant, implement this method to return getPreferredSize.

Specified by:

getPreferredScrollableViewportSize in interface javax.swing.Scrollable

---

getScrollableTracksViewportWidth

public boolean getScrollableTracksViewportWidth()

If we are is displayed in a JViewport, don't change its width when the viewports width changes. This allows horizontal scrolling if the JViewport is itself embedded in a JScrollPane.

Specified by:

getScrollableTracksViewportWidth in interface javax.swing.Scrollable

---

getScrollableTracksViewportHeight

public boolean getScrollableTracksViewportHeight()

If we are is displayed in a JViewport, don't change its height when the viewports height changes. This allows vertical scrolling if the JViewport is itself embedded in a JScrollPane.

Specified by:

getScrollableTracksViewportHeight in interface javax.swing.Scrollable

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> org >> crosswire >> bible >> map >> [ view overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---