Class SwingStatusBar

  • All Implemented Interfaces:
    StatusBar, ViewerComponent, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

    public class SwingStatusBar
    extends javax.swing.JPanel
    implements StatusBar
    Swing implementation of the Statusbar.
    Since:
    7.0
    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 Description
      protected java.beans.PropertyChangeSupport propertySupporter
      FOR INTERNAL USE ONLY
      • Fields inherited from class javax.swing.JComponent

        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

        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
      SwingStatusBar​(ReportView view)
      Creates a new instance of the StatusBar connected to the given ReportView.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addStateChangeListener​(java.beans.PropertyChangeListener l)
      Adds a PropertyChangeListener to the listener list.
      void clearInfoMessage()
      Remove the current info message from the StatusBar.Calling this method will bring a status message(if set) back to screen.
      void clearStatusMessage()
      Remove the current status message from the StatusBar.
      java.awt.Component getComponent()
      All public graphical components of the viewer must implement this method, which returns the actual AWT component so that it can be added to containers, etc.
      For example, if you have a "ReportViewer" and would like to add it to your own JFrame, simply call: myFrame.add(viewer.getComponent())
      java.lang.String getInfoMessage()
      Returns the current info message from the statusbar.
      java.lang.String getStatusMessage()
      Returns the current status message from the statusbar.
      void removeStateChangeListener​(java.beans.PropertyChangeListener l)
      Removes a PropertyChangeListener from this progress.
      void setInfoMessage​(java.lang.String message)
      Sets and shows a info message in this StatusBar.
      void setStatusIcon​(javax.swing.Icon icon)
      Displays the specified icon in this Statusbar.
      void setStatusMessage​(java.lang.String message, boolean isError)
      Sets and shows, if no info message is set, a status message in this StatusBar.
      • 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, 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, 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
    • Field Detail

      • propertySupporter

        protected java.beans.PropertyChangeSupport propertySupporter
        FOR INTERNAL USE ONLY
    • Constructor Detail

      • SwingStatusBar

        public SwingStatusBar​(ReportView view)
        Creates a new instance of the StatusBar connected to the given ReportView. This also inititializes the GUI of this status bar.
        Parameters:
        view - ReportView to which this StatusBar is to belong.
        Since:
        7.0
    • Method Detail

      • getComponent

        public java.awt.Component getComponent()
        All public graphical components of the viewer must implement this method, which returns the actual AWT component so that it can be added to containers, etc.
        For example, if you have a "ReportViewer" and would like to add it to your own JFrame, simply call: myFrame.add(viewer.getComponent())
        Specified by:
        getComponent in interface ViewerComponent
        Returns:
        Actual AWT component of this object.
        Since:
        7.0
      • addStateChangeListener

        public void addStateChangeListener​(java.beans.PropertyChangeListener l)
        Adds a PropertyChangeListener to the listener list. The Listener will be informed about all changed status messages of the status bar.
        Specified by:
        addStateChangeListener in interface StatusBar
        Parameters:
        l - PropertyChangeListener
        Since:
        7.0
      • removeStateChangeListener

        public void removeStateChangeListener​(java.beans.PropertyChangeListener l)
        Removes a PropertyChangeListener from this progress.
        Specified by:
        removeStateChangeListener in interface StatusBar
        Parameters:
        l - PropertyChangeListener
        Since:
        7.0
      • clearInfoMessage

        public void clearInfoMessage()
        Remove the current info message from the StatusBar.Calling this method will bring a status message(if set) back to screen.
        Specified by:
        clearInfoMessage in interface StatusBar
        Since:
        7.0
      • clearStatusMessage

        public void clearStatusMessage()
        Remove the current status message from the StatusBar.
        Specified by:
        clearStatusMessage in interface StatusBar
        Since:
        7.0
      • getInfoMessage

        public java.lang.String getInfoMessage()
        Returns the current info message from the statusbar.
        Specified by:
        getInfoMessage in interface StatusBar
        Returns:
        Returns the current info message.
        Since:
        7.0
      • getStatusMessage

        public java.lang.String getStatusMessage()
        Returns the current status message from the statusbar.
        Specified by:
        getStatusMessage in interface StatusBar
        Returns:
        Returns the current status message.
        Since:
        7.0
      • setInfoMessage

        public void setInfoMessage​(java.lang.String message)
        Sets and shows a info message in this StatusBar. This message will be shown until StatusBar.clearInfoMessage() is called or a new info message is set. A status message cant overwrite an info message and calling StatusBar.clearInfoMessage() will bring the status message (if set) back to screen.
        Specified by:
        setInfoMessage in interface StatusBar
        Parameters:
        message - The info message to show.
        Since:
        7.0
      • setStatusMessage

        public void setStatusMessage​(java.lang.String message,
                                     boolean isError)
        Sets and shows, if no info message is set, a status message in this StatusBar. This message will be shown until StatusBar.clearStatusMessage() is called or an infor or a new status message is set. If isError is set the message will be displayed as an error (red color).
        Specified by:
        setStatusMessage in interface StatusBar
        Parameters:
        message - The status message to show.
        isError - If true the status message will be displayed red.
        Since:
        7.0
      • setStatusIcon

        public void setStatusIcon​(javax.swing.Icon icon)
        Displays the specified icon in this Statusbar. Defines the icon this component will display. If the value of icon is null, nothing is displayed.
        Parameters:
        icon - the given icon (null possible)
        Since:
        10.0