Package org.geotools.swing.control

Class JMapStatusBar

  • All Implemented Interfaces:
    ImageObserver, MenuContainer, Serializable, Accessible
    public class JMapStatusBar
extends JPanel
    A status bar that works with a map pane to display cursor coordinates and other data. The static createDefaultStatusBar(org.geotools.swing.MapPane) method can be used for the most common configuration.
    Since:
    8.0
    Author:
    Michael Bedward
    See Also:
    StatusBarItem, Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class JPanel

        JPanel.AccessibleJPanel

      • Nested classes/interfaces inherited from class JComponent

        JComponent.AccessibleJComponent

      • Nested classes/interfaces inherited from class Container

        Container.AccessibleAWTContainer

      • Nested classes/interfaces inherited from class Component

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

    • Field Summary

      • Fields inherited from class JComponent

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

      • Fields inherited from class Component

        accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

      • Fields inherited from interface ImageObserver

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

    • Constructor Summary

      Constructors 
      Constructor Description
      JMapStatusBar()
      Creates a new status bar.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean addItem​(StatusBarItem item)
      Adds a new item to the status bar.
      boolean addItem​(StatusBarItem item, boolean configurable, boolean showing)
      Adds a new item to the status bar.
      static JMapStatusBar createDefaultStatusBar​(MapPane mapPane)
      Creates a new status bar, with the default set of items, linked to the given map pane.
      int findItem​(StatusBarItem item)
      Searches for the given item in the current set of status bar items.
      StatusBarItem getItem​(int index)
      Gets the item at the specified position index.
      int getNumItems()
      Gets the number of items in this status bar including the default configuration menu item.

      • Methods inherited from class JPanel

        getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

      • Methods inherited from class 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, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

      • Methods inherited from class 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 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 Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • JMapStatusBar

        public JMapStatusBar()
        Creates a new status bar. Sets a MigLayout layout manager and adds the default config menu status item.

    • Method Detail

      • createDefaultStatusBar

        public static JMapStatusBar createDefaultStatusBar​(MapPane mapPane)
        Creates a new status bar, with the default set of items, linked to the given map pane. This method can be called safely from any thread.

        The default items are:

        • cursor coordinate item
        • map extent item
        • coordinate reference system item
        • rendering activity item
        Parameters:
        mapPane - the map pane linked to the status bar
        Returns:
        a new status bar
        Throws:
        IllegalArgumentException - if mapPane is null

      • addItem

        public boolean addItem​(StatusBarItem item)
        Adds a new item to the status bar. The item will display a border and appear in the status bar configuration menu. If the item is already present in the status bar it will not added again and the method will return false.
        Parameters:
        item - the item to add
        Returns:
        true if the item was added

      • addItem

        public boolean addItem​(StatusBarItem item,
                       boolean configurable,
                       boolean showing)
        Adds a new item to the status bar. If the item is already present in the status bar it will not added again and the method will return false.
        Parameters:
        item - the item to add
        configurable - whether the item should appear in the status bar configuration menu
        showing - whether the item should be shown initially
        Returns:
        true if the item was added

      • getNumItems

        public int getNumItems()
        Gets the number of items in this status bar including the default configuration menu item.
        Returns:
        number of status bar items

      • findItem

        public int findItem​(StatusBarItem item)
        Searches for the given item in the current set of status bar items. If found, the item's position index is returned; otherwise -1.
        Parameters:
        item - the item to search for
        Returns:
        position index or -1 if not found

      • getItem

        public StatusBarItem getItem​(int index)
        Gets the item at the specified position index. Position 0 is always occupied by the status bar's configuration menu item.
        Parameters:
        index - position index between 0 and getNumItems() - 1
        Returns:
        the item
        Throws:
        IndexOutOfBoundsException - on invalid index value