com.jidesoft.editor.status
Class CaretStatusBarItem

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  com.jidesoft.swing.NullPanel
                      com.jidesoft.status.StatusBarItem
                          com.jidesoft.status.LabelStatusBarItem
                              com.jidesoft.editor.status.AbstractCodeEditorStatusBarItem
                                  com.jidesoft.editor.status.CaretStatusBarItem

All Implemented Interfaces:

CaretListener, CodeEditorStatusBarItem, ImageObserver, MenuContainer, Serializable, EventListener, Accessible

Direct Known Subclasses:

CaretModelPositionStatusBarItem, CaretOffsetStatusBarItem, CaretViewPositionStatusBarItem

public abstract class CaretStatusBarItem
extends AbstractCodeEditorStatusBarItem
implements CaretListener

A special StatusBarItem which is used to show the information about caret position. It has one abstract method caretUpdated(com.jidesoft.editor.caret.CaretEvent). This method is called whenever caret position changes.

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 com.jidesoft.editor.status.AbstractCodeEditorStatusBarItem

_editor

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

CaretStatusBarItem()

CaretStatusBarItem(String name)

Method Summary

void	caretUpdated(CaretEvent e) This method will be called whenever caret position changes.
void	initialize() Initializes the status bar item.
void	registerListener(CodeEditor editor) Status bar item needs to keep track of a certain status in code editor.
void	unregisterListener(CodeEditor editor) Removes the listener you registered in CodeEditorStatusBarItem.registerListener(com.jidesoft.editor.CodeEditor).

Methods inherited from class com.jidesoft.editor.status.AbstractCodeEditorStatusBarItem

getCodeEditor, setCodeEditor

Methods inherited from class com.jidesoft.status.LabelStatusBarItem

addMouseListener, configureLabel, createLabel, getComponent, getHorizontalAlignment, getIcon, getItemName, getPreferredSize, getText, getToolTipLocation, getToolTipText, setAlignment, setEnabled, setHorizontalAlignment, setIcon, setText, setToolTip, setToolTipText

Methods inherited from class com.jidesoft.status.StatusBarItem

getPreferredWidth, setPreferredWidth, updateUI

Methods inherited from class com.jidesoft.swing.NullPanel

setBackground, setFont, setForeground

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI

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, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setFocusTraversalKeys, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, 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, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, 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

CaretStatusBarItem

public CaretStatusBarItem()

CaretStatusBarItem

public CaretStatusBarItem(String name)

Method Detail

initialize

public void initialize()

Description copied from interface: CodeEditorStatusBarItem

Initializes the status bar item. Usually you do things like set preferred width, set alignment etc in this method.

Specified by:

initialize in interface CodeEditorStatusBarItem

registerListener

public void registerListener(CodeEditor editor)

Description copied from interface: CodeEditorStatusBarItem

Status bar item needs to keep track of a certain status in code editor. So you should use this method to register a kind of listener to editor so that you can get notified when status changes. You should also update the current status and display on the status bar item.

For example, if this is a caret position status bar item, you should add CaretListener to the editor. And you should also retrive current caret position and display it.

Specified by:

registerListener in interface CodeEditorStatusBarItem

unregisterListener

public void unregisterListener(CodeEditor editor)

Description copied from interface: CodeEditorStatusBarItem

Removes the listener you registered in CodeEditorStatusBarItem.registerListener(com.jidesoft.editor.CodeEditor).

Specified by:

unregisterListener in interface CodeEditorStatusBarItem

caretUpdated

public void caretUpdated(CaretEvent e)

Description copied from interface: CaretListener

This method will be called whenever caret position changes.

Specified by:

caretUpdated in interface CaretListener

Parameters:

e - the CaretEvent.