org.fife.rtext
Class StatusBar

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.fife.ui.StatusBarPanel
                      org.fife.ui.StatusBar
                          org.fife.rtext.StatusBar

All Implemented Interfaces:

java.awt.event.MouseListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.beans.PropertyChangeListener, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

public class StatusBar
extends StatusBar
implements java.beans.PropertyChangeListener

The status bar used by rtext. Contains fields for:

• An informational/status message.
• A line/column number.
• An overwrite (insert) mode indicator.
• A Caps Lock indicator.
• A file "Read Only" mode indicator.

Version:

1.0

Author:

Robert Futrell

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 inherited from class org.fife.ui.StatusBar

DEFAULT_STATUS_MESSAGE, STYLE_PROPERTY, WINDOWS_98_STYLE, WINDOWS_XP_STYLE

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

StatusBar(RText rtext, java.lang.String defaultMessage, boolean showRowColumn, int newRow, int newColumn, boolean overwriteModeEnabled)
Creates the status bar.

Method Summary

void	decColumn() Decrements the value of column in row/column indicator.
void	decRow() Decrements the value of row in row/column indicator.
void	incColumn() Increments the value of column in row/column indicator.
void	incRow() Increments the value of row in row/column indicator.
boolean	isCapsLockIndicatorEnabled() Returns true if the caps lock indicator is enabled.
boolean	isOverwriteModeIndicatorEnabled() Returns true if overwrite mode indicator is enabled.
boolean	isReadOnlyIndicatorEnabled() Returns true if the Read Only indicator is enabled.
boolean	isRowColumnIndicatorVisible() Returns whether or not the row/column indicator is visible.
void	propertyChange(java.beans.PropertyChangeEvent e) Called whenever a property changes on a component we're listening to.
void	setCapsLockIndicatorEnabled(boolean enabled) Changes whether the caps lock indicator is enabled or disabled.
void	setColumn(int newColumn) Setter function for the column in row/column indicator.
void	setOverwriteModeIndicatorEnabled(boolean enabled) Changes whether the overwrite indicator is enabled or disabled.
void	setReadOnlyIndicatorEnabled(boolean enabled) Changes whether the Read Only indicator is enabled or disabled.
void	setRow(int newRow) Setter function for the row in row/column indicator.
void	setRowAndColumn(int newRow, int newColumn) Setter function for row/column part of status bar.
void	setRowColumnIndicatorVisible(boolean isVisible) Enables or disables the row/column indicator.

Methods inherited from class org.fife.ui.StatusBar

addStatusBarComponent, addStatusBarComponent, applyComponentOrientation, getDefaultStatusMessage, getStatusMessage, getStyle, mouseClicked, mouseEntered, mouseExited, mousePressed, mouseReleased, setStatusMessage, setStyle

Methods inherited from class org.fife.ui.StatusBarPanel

isShadowEnabled, paintComponent, setShadowEnabled

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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, 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, 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, transferFocusBackward, 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, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, 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, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

StatusBar

public StatusBar(RText rtext,
                 java.lang.String defaultMessage,
                 boolean showRowColumn,
                 int newRow,
                 int newColumn,
                 boolean overwriteModeEnabled)

Creates the status bar.

Parameters:

defaultMessage - The default status message for this status bar.

showRowColumn - If true, the row/column of the caret are displayed.

newRow - The initial value of the row that is displayed.

newColumn - The initial value fo the column that is displayed.

overwriteModeEnabled - If true, overwrite mode indicator ("OVR") is enabled.

Method Detail

decColumn

public void decColumn()

Decrements the value of column in row/column indicator.

decRow

public void decRow()

Decrements the value of row in row/column indicator.

incColumn

public void incColumn()

Increments the value of column in row/column indicator.

incRow

public void incRow()

Increments the value of row in row/column indicator.

isCapsLockIndicatorEnabled

public boolean isCapsLockIndicatorEnabled()

Returns true if the caps lock indicator is enabled.

isOverwriteModeIndicatorEnabled

public boolean isOverwriteModeIndicatorEnabled()

Returns true if overwrite mode indicator is enabled.

isReadOnlyIndicatorEnabled

public boolean isReadOnlyIndicatorEnabled()

Returns true if the Read Only indicator is enabled.

isRowColumnIndicatorVisible

public boolean isRowColumnIndicatorVisible()

Returns whether or not the row/column indicator is visible.

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent e)

Called whenever a property changes on a component we're listening to.

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

setCapsLockIndicatorEnabled

public void setCapsLockIndicatorEnabled(boolean enabled)

Changes whether the caps lock indicator is enabled or disabled. This should be called whenever the user presses CAPS LOCK, perhaps through a KeyListener.

Parameters:

enabled - If true, the caps indicator ("OVR") is enabled; if false, it is disabled.

setColumn

public void setColumn(int newColumn)

Setter function for the column in row/column indicator.

Parameters:

newColumn - The column value to display for the caret.

setOverwriteModeIndicatorEnabled

public void setOverwriteModeIndicatorEnabled(boolean enabled)

Changes whether the overwrite indicator is enabled or disabled.

Parameters:

enabled - If true, the overwrite indicator ("OVR") is enabled; if false, it is disabled.

setReadOnlyIndicatorEnabled

public void setReadOnlyIndicatorEnabled(boolean enabled)

Changes whether the Read Only indicator is enabled or disabled.

Parameters:

enabled - If true, the read-only indicator is enabled; if false, it is disabled.

setRow

public void setRow(int newRow)

Setter function for the row in row/column indicator.

Parameters:

newRow - The row value to display for the caret.

setRowAndColumn

public void setRowAndColumn(int newRow,
                            int newColumn)

Setter function for row/column part of status bar.

Parameters:

newRow - The row value to display for the caret.

newColumn - The column value to display for the caret.

setRowColumnIndicatorVisible

public void setRowColumnIndicatorVisible(boolean isVisible)

Enables or disables the row/column indicator.

Parameters:

isVisible - Whether or not the row/column indicator should be visible.