edu.ou.kmi.buddyspace.utils
Class AutoScrollTextPane

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.text.JTextComponent
                          |
                          +--javax.swing.JEditorPane
                                |
                                +--javax.swing.JTextPane
                                      |
                                      +--edu.ou.kmi.buddyspace.utils.AutoScrollTextPane
All Implemented Interfaces:
javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.Scrollable, java.io.Serializable
Direct Known Subclasses:
BSAutoScrollTextPane

public class AutoScrollTextPane
extends javax.swing.JTextPane

AutoScrollTextPane is JTextPane subclass which provides styles for IM and automatically scrolls to the top or bottom.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class javax.swing.JEditorPane
javax.swing.JEditorPane.AccessibleJEditorPane, javax.swing.JEditorPane.AccessibleJEditorPaneHTML, javax.swing.JEditorPane.JEditorPaneAccessibleHypertextSupport
 
Nested classes inherited from class javax.swing.text.JTextComponent
javax.swing.text.JTextComponent.AccessibleJTextComponent, javax.swing.text.JTextComponent.KeyBinding
 
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
protected  boolean autoScrollDown
           
static java.lang.String BUDDY_NICK_STYLE
           
protected  javax.swing.text.Document doc
           
static java.lang.String HTML_STYLE
           
static java.lang.String MY_NICK_STYLE
           
protected static java.lang.String NICK_STYLE
           
static java.lang.String PRESENCE_STYLE
           
static java.lang.String RECEIVED_XML_STYLE
           
static java.lang.String REGULAR_STYLE
          styles
static java.lang.String SEND_ERR_XML_STYLE
           
static java.lang.String SENT_XML_STYLE
           
static java.lang.String[] smileyFiles
          array of emoticon icon filenames
static javax.swing.ImageIcon[] smileyIcons
          array of emoticon icons
static java.lang.String SMILEYS_STYLE
           
static java.lang.String[] smileyStrs
          array of emoticon strings
static java.util.Hashtable smiliesBackHashtable
           
static java.util.Hashtable smiliesHashtable
          hashtables for conversion between emoticons and their icons
static java.lang.String TIME_STAMP_STYLE
           
static java.lang.String URL_DESC_STYLE
           
static java.lang.String URL_STYLE
           
 
Fields inherited from class javax.swing.text.JTextComponent
DEFAULT_KEYMAP, FOCUS_ACCELERATOR_KEY
 
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
AutoScrollTextPane(boolean autoScrollDown)
          Constructor defining if the pane will automatically scroll to the top or bottom.
 
Method Summary
 void append(java.lang.String str, java.lang.String styleName)
          Overloaded append function, which scrolls down
 void appendHTML(java.lang.String htmlSource)
          Appends text as HTML
protected  void appendHTMLImpl(java.lang.String htmlSource)
          Implementation of appending text as HTML
protected  void appendImpl(java.lang.String str, java.lang.String styleName)
          Appends given text using given style
protected  void appendSmiley(javax.swing.Icon smileyIcon)
          Appends smiley icon
 void clear()
          Clears the pane
protected  void initSmilies()
          Initiates smilies hashtable
protected  void initStyles()
          Inits styles
protected  void parseSmileys(java.lang.String str, java.lang.String styleName)
          Parses the text and appends it with icons for smilies
 void scroll()
          Scrolls according to given policy
 
Methods inherited from class javax.swing.JTextPane
addStyle, createDefaultEditorKit, getCharacterAttributes, getInputAttributes, getLogicalStyle, getParagraphAttributes, getStyle, getStyledDocument, getStyledEditorKit, getUIClassID, insertComponent, insertIcon, paramString, removeStyle, replaceSelection, setCharacterAttributes, setDocument, setEditorKit, setLogicalStyle, setParagraphAttributes, setStyledDocument
 
Methods inherited from class javax.swing.JEditorPane
addHyperlinkListener, createEditorKitForContentType, fireHyperlinkUpdate, getAccessibleContext, getContentType, getEditorKit, getEditorKitClassNameForContentType, getEditorKitForContentType, getHyperlinkListeners, getPage, getPreferredSize, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getStream, getText, read, registerEditorKitForContentType, registerEditorKitForContentType, removeHyperlinkListener, scrollToReference, setContentType, setEditorKitForContentType, setPage, setPage, setText
 
Methods inherited from class javax.swing.text.JTextComponent
addCaretListener, addInputMethodListener, addKeymap, copy, cut, fireCaretUpdate, getActions, getCaret, getCaretColor, getCaretListeners, getCaretPosition, getDisabledTextColor, getDocument, getDragEnabled, getFocusAccelerator, getHighlighter, getInputMethodRequests, getKeymap, getKeymap, getMargin, getNavigationFilter, getPreferredScrollableViewportSize, getScrollableBlockIncrement, getScrollableUnitIncrement, getSelectedText, getSelectedTextColor, getSelectionColor, getSelectionEnd, getSelectionStart, getText, getToolTipText, getUI, isEditable, loadKeymap, modelToView, moveCaretPosition, paste, processInputMethodEvent, read, removeCaretListener, removeKeymap, removeNotify, select, selectAll, setCaret, setCaretColor, setCaretPosition, setComponentOrientation, setDisabledTextColor, setDragEnabled, setEditable, setFocusAccelerator, setHighlighter, setKeymap, setMargin, setNavigationFilter, setSelectedTextColor, setSelectionColor, setSelectionEnd, setSelectionStart, setUI, updateUI, viewToModel, write
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, 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, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removePropertyChangeListener, removePropertyChangeListener, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class java.awt.Component
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, 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
 

Field Detail

doc

protected javax.swing.text.Document doc

autoScrollDown

protected boolean autoScrollDown

REGULAR_STYLE

public static final java.lang.String REGULAR_STYLE
styles

See Also:
Constant Field Values

NICK_STYLE

protected static final java.lang.String NICK_STYLE
See Also:
Constant Field Values

MY_NICK_STYLE

public static final java.lang.String MY_NICK_STYLE
See Also:
Constant Field Values

BUDDY_NICK_STYLE

public static final java.lang.String BUDDY_NICK_STYLE
See Also:
Constant Field Values

PRESENCE_STYLE

public static final java.lang.String PRESENCE_STYLE
See Also:
Constant Field Values

TIME_STAMP_STYLE

public static final java.lang.String TIME_STAMP_STYLE
See Also:
Constant Field Values

SMILEYS_STYLE

public static final java.lang.String SMILEYS_STYLE
See Also:
Constant Field Values

URL_STYLE

public static final java.lang.String URL_STYLE
See Also:
Constant Field Values

URL_DESC_STYLE

public static final java.lang.String URL_DESC_STYLE
See Also:
Constant Field Values

HTML_STYLE

public static final java.lang.String HTML_STYLE
See Also:
Constant Field Values

SENT_XML_STYLE

public static final java.lang.String SENT_XML_STYLE
See Also:
Constant Field Values

RECEIVED_XML_STYLE

public static final java.lang.String RECEIVED_XML_STYLE
See Also:
Constant Field Values

SEND_ERR_XML_STYLE

public static final java.lang.String SEND_ERR_XML_STYLE
See Also:
Constant Field Values

smiliesHashtable

public static java.util.Hashtable smiliesHashtable
hashtables for conversion between emoticons and their icons


smiliesBackHashtable

public static java.util.Hashtable smiliesBackHashtable

smileyStrs

public static final java.lang.String[] smileyStrs
array of emoticon strings


smileyFiles

public static final java.lang.String[] smileyFiles
array of emoticon icon filenames


smileyIcons

public static javax.swing.ImageIcon[] smileyIcons
array of emoticon icons

Constructor Detail

AutoScrollTextPane

public AutoScrollTextPane(boolean autoScrollDown)
Constructor defining if the pane will automatically scroll to the top or bottom.

Method Detail

initSmilies

protected void initSmilies()
Initiates smilies hashtable


initStyles

protected void initStyles()
Inits styles


append

public void append(java.lang.String str,
                   java.lang.String styleName)
Overloaded append function, which scrolls down


parseSmileys

protected void parseSmileys(java.lang.String str,
                            java.lang.String styleName)
Parses the text and appends it with icons for smilies


appendSmiley

protected void appendSmiley(javax.swing.Icon smileyIcon)
Appends smiley icon


appendImpl

protected void appendImpl(java.lang.String str,
                          java.lang.String styleName)
Appends given text using given style


clear

public void clear()
Clears the pane


scroll

public void scroll()
Scrolls according to given policy


appendHTML

public void appendHTML(java.lang.String htmlSource)
Appends text as HTML


appendHTMLImpl

protected void appendHTMLImpl(java.lang.String htmlSource)
Implementation of appending text as HTML