jsyntaxpane.actions
Class CompleteWordAction

java.lang.Object
  javax.swing.AbstractAction
      javax.swing.text.TextAction
          jsyntaxpane.actions.DefaultSyntaxAction
              jsyntaxpane.actions.CompleteWordAction

All Implemented Interfaces:

java.awt.event.ActionListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, javax.swing.Action, SyntaxAction

public class CompleteWordAction
extends DefaultSyntaxAction

This action will try to complete the word at the cursor by looking for a matching word in this document that starts with the same letters. This makes use of the SyntaxDocument.getWordAt, which requires a Regexp Pattern. The Pattern should match any word regardless of the Tokens. This Regexp is configurable with ACTION_NAME.WordsRegexp. The default Regexp is \w+ (any word char)

Author:

Ayman Al-Sairafi

See Also:

Serialized Form

Field Summary

Fields inherited from class jsyntaxpane.actions.DefaultSyntaxAction

ACTION_PREFIX, LARGE_ICONS_LOC_PREFIX, SMALL_ICONS_LOC_PREFIX

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

CompleteWordAction()

Method Summary

void	actionPerformed(javax.swing.text.JTextComponent target, SyntaxDocument sdoc, int dot, java.awt.event.ActionEvent e) Convenience method that will be called if the Action is performed on a JTextComponent.
void	setWordsRegexp(java.lang.String value)

Methods inherited from class jsyntaxpane.actions.DefaultSyntaxAction

actionPerformed, config, setLargeIcon, setMenuText, setSmallIcon, setToolTip, toString

Methods inherited from class javax.swing.text.TextAction

augmentList, getFocusedComponent, getTextComponent

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.swing.Action

addPropertyChangeListener, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Constructor Detail

CompleteWordAction

public CompleteWordAction()

Method Detail

actionPerformed

public void actionPerformed(javax.swing.text.JTextComponent target,
                            SyntaxDocument sdoc,
                            int dot,
                            java.awt.event.ActionEvent e)

Description copied from class: DefaultSyntaxAction

Convenience method that will be called if the Action is performed on a JTextComponent. SyntaxActions should generally override this method.

Overrides:

actionPerformed in class DefaultSyntaxAction

Parameters:

target - (non-null JTextComponent from Action.getSource

sdoc - (SyntaxDOcument of the text component, could be null)

dot - (position of caret at text document)

e - actual ActionEvent passed to actionPerformed

setWordsRegexp

public void setWordsRegexp(java.lang.String value)