KeyBinding instance.
*
* @param key a KeyStroke value
* @param actionName a String value
*/
public KeyBinding(KeyStroke key, String actionName)
{
this.key = key;
this.actionName = actionName;
}
}
/**
* According to this
* report, a pair of private classes wraps a {@link
* javax.swing.text.Keymap} in the new {@link InputMap} / {@link
* ActionMap} interfaces, such that old Keymap-using code can make use of
* the new framework.
*
* A little bit of experimentation with these classes reveals the following * structure: * *
key, or null
* if no mapping exists in this Keymap or any of its parents.
*/
public Action getAction(KeyStroke key)
{
if (map.containsKey(key))
return (Action) map.get(key);
else if (parent != null)
return parent.getAction(key);
else
return null;
}
public Action[] getBoundActions()
{
Action [] ret = new Action[map.size()];
Enumeration e = map.elements();
int i = 0;
while (e.hasMoreElements())
{
ret[i++] = (Action) e.nextElement();
}
return ret;
}
public KeyStroke[] getBoundKeyStrokes()
{
KeyStroke [] ret = new KeyStroke[map.size()];
Enumeration e = map.keys();
int i = 0;
while (e.hasMoreElements())
{
ret[i++] = (KeyStroke) e.nextElement();
}
return ret;
}
public Action getDefaultAction()
{
return defaultAction;
}
public KeyStroke[] getKeyStrokesForAction(Action a)
{
int i = 0;
Enumeration e = map.keys();
while (e.hasMoreElements())
{
if (map.get(e.nextElement()).equals(a))
++i;
}
KeyStroke [] ret = new KeyStroke[i];
i = 0;
e = map.keys();
while (e.hasMoreElements())
{
KeyStroke k = (KeyStroke) e.nextElement();
if (map.get(k).equals(a))
ret[i++] = k;
}
return ret;
}
public String getName()
{
return name;
}
public Keymap getResolveParent()
{
return parent;
}
public boolean isLocallyDefined(KeyStroke key)
{
return map.containsKey(key);
}
public void removeBindings()
{
map.clear();
}
public void removeKeyStrokeBinding(KeyStroke key)
{
map.remove(key);
}
public void setDefaultAction(Action a)
{
defaultAction = a;
}
public void setResolveParent(Keymap p)
{
parent = p;
}
}
class DefaultTransferHandler extends TransferHandler
{
public boolean canImport(JComponent component, DataFlavor[] flavors)
{
JTextComponent textComponent = (JTextComponent) component;
if (! (textComponent.isEnabled()
&& textComponent.isEditable()
&& flavors != null))
return false;
for (int i = 0; i < flavors.length; ++i)
if (flavors[i].equals(DataFlavor.stringFlavor))
return true;
return false;
}
public void exportToClipboard(JComponent component, Clipboard clipboard,
int action)
{
JTextComponent textComponent = (JTextComponent) component;
int start = textComponent.getSelectionStart();
int end = textComponent.getSelectionEnd();
if (start == end)
return;
try
{
// Copy text to clipboard.
String data = textComponent.getDocument().getText(start, end);
StringSelection selection = new StringSelection(data);
clipboard.setContents(selection, null);
// Delete selected text on cut action.
if (action == MOVE)
doc.remove(start, end - start);
}
catch (BadLocationException e)
{
// Ignore this and do nothing.
}
}
public int getSourceActions()
{
return NONE;
}
public boolean importData(JComponent component, Transferable transferable)
{
DataFlavor flavor = null;
DataFlavor[] flavors = transferable.getTransferDataFlavors();
if (flavors == null)
return false;
for (int i = 0; i < flavors.length; ++i)
if (flavors[i].equals(DataFlavor.stringFlavor))
flavor = flavors[i];
if (flavor == null)
return false;
try
{
JTextComponent textComponent = (JTextComponent) component;
String data = (String) transferable.getTransferData(flavor);
textComponent.replaceSelection(data);
return true;
}
catch (IOException e)
{
// Ignored.
}
catch (UnsupportedFlavorException e)
{
// Ignored.
}
return false;
}
}
private static final long serialVersionUID = -8796518220218978795L;
public static final String DEFAULT_KEYMAP = "default";
public static final String FOCUS_ACCELERATOR_KEY = "focusAcceleratorKey";
private static DefaultTransferHandler defaultTransferHandler;
private static Hashtable keymaps = new Hashtable();
private Keymap keymap;
private char focusAccelerator = '\0';
private NavigationFilter navigationFilter;
/**
* Get a Keymap from the global keymap table, by name.
*
* @param n The name of the Keymap to look up
*
* @return A Keymap associated with the provided name, or
* null if no such Keymap exists
*
* @see #addKeymap
* @see #removeKeymap
* @see #keymaps
*/
public static Keymap getKeymap(String n)
{
return (Keymap) keymaps.get(n);
}
/**
* Remove a Keymap from the global Keymap table, by name.
*
* @param n The name of the Keymap to remove
*
* @return The keymap removed from the global table
*
* @see #addKeymap
* @see #getKeymap()
* @see #keymaps
*/
public static Keymap removeKeymap(String n)
{
Keymap km = (Keymap) keymaps.get(n);
keymaps.remove(n);
return km;
}
/**
* Create a new Keymap with a specific name and parent, and add the new
* Keymap to the global keymap table. The name may be null,
* in which case the new Keymap will not be added to the global
* Keymap table. The parent may also be null, which is
* harmless.
*
* @param n The name of the new Keymap, or null
* @param parent The parent of the new Keymap, or null
*
* @return The newly created Keymap
*
* @see #removeKeymap
* @see #getKeymap()
* @see #keymaps
*/
public static Keymap addKeymap(String n, Keymap parent)
{
Keymap k = new DefaultKeymap(n);
k.setResolveParent(parent);
if (n != null)
keymaps.put(n, k);
return k;
}
/**
* Get the current Keymap of this component.
*
* @return The component's current Keymap
*
* @see #setKeymap
* @see #keymap
*/
public Keymap getKeymap()
{
return keymap;
}
/**
* Set the current Keymap of this component, installing appropriate
* {@link KeymapWrapper} and {@link KeymapActionMap} objects in the
* {@link InputMap} and {@link ActionMap} parent chains, respectively,
* and fire a property change event with name "keymap".
*
* @see #getKeymap()
* @see #keymap
*/
public void setKeymap(Keymap k)
{
// phase 1: replace the KeymapWrapper entry in the InputMap chain.
// the goal here is to always maintain the following ordering:
//
// [InputMap]? -> [KeymapWrapper]? -> [InputMapUIResource]*
//
// that is to say, component-specific InputMaps need to remain children
// of Keymaps, and Keymaps need to remain children of UI-installed
// InputMaps (and the order of each group needs to be preserved, of
// course).
KeymapWrapper kw = (k == null ? null : new KeymapWrapper(k));
InputMap childInputMap = getInputMap(JComponent.WHEN_FOCUSED);
if (childInputMap == null)
setInputMap(JComponent.WHEN_FOCUSED, kw);
else
{
while (childInputMap.getParent() != null
&& !(childInputMap.getParent() instanceof KeymapWrapper)
&& !(childInputMap.getParent() instanceof InputMapUIResource))
childInputMap = childInputMap.getParent();
// option 1: there is nobody to replace at the end of the chain
if (childInputMap.getParent() == null)
childInputMap.setParent(kw);
// option 2: there is already a KeymapWrapper in the chain which
// needs replacing (possibly with its own parents, possibly without)
else if (childInputMap.getParent() instanceof KeymapWrapper)
{
if (kw == null)
childInputMap.setParent(childInputMap.getParent().getParent());
else
{
kw.setParent(childInputMap.getParent().getParent());
childInputMap.setParent(kw);
}
}
// option 3: there is an InputMapUIResource in the chain, which marks
// the place where we need to stop and insert ourselves
else if (childInputMap.getParent() instanceof InputMapUIResource)
{
if (kw != null)
{
kw.setParent(childInputMap.getParent());
childInputMap.setParent(kw);
}
}
}
// phase 2: replace the KeymapActionMap entry in the ActionMap chain
KeymapActionMap kam = (k == null ? null : new KeymapActionMap(k));
ActionMap childActionMap = getActionMap();
if (childActionMap == null)
setActionMap(kam);
else
{
while (childActionMap.getParent() != null
&& !(childActionMap.getParent() instanceof KeymapActionMap)
&& !(childActionMap.getParent() instanceof ActionMapUIResource))
childActionMap = childActionMap.getParent();
// option 1: there is nobody to replace at the end of the chain
if (childActionMap.getParent() == null)
childActionMap.setParent(kam);
// option 2: there is already a KeymapActionMap in the chain which
// needs replacing (possibly with its own parents, possibly without)
else if (childActionMap.getParent() instanceof KeymapActionMap)
{
if (kam == null)
childActionMap.setParent(childActionMap.getParent().getParent());
else
{
kam.setParent(childActionMap.getParent().getParent());
childActionMap.setParent(kam);
}
}
// option 3: there is an ActionMapUIResource in the chain, which marks
// the place where we need to stop and insert ourselves
else if (childActionMap.getParent() instanceof ActionMapUIResource)
{
if (kam != null)
{
kam.setParent(childActionMap.getParent());
childActionMap.setParent(kam);
}
}
}
// phase 3: update the explicit keymap field
Keymap old = keymap;
keymap = k;
firePropertyChange("keymap", old, k);
}
/**
* Resolves a set of bindings against a set of actions and inserts the
* results into a {@link Keymap}. Specifically, for each provided binding
* b, if there exists a provided action a such
* that a.getValue(Action.NAME) == b.ActionName then an
* entry is added to the Keymap mapping b to
* a.
*
* @param map The Keymap to add new mappings to
* @param bindings The set of bindings to add to the Keymap
* @param actions The set of actions to resolve binding names against
*
* @see Action#NAME
* @see Action#getValue
* @see KeyBinding#actionName
*/
public static void loadKeymap(Keymap map,
JTextComponent.KeyBinding[] bindings,
Action[] actions)
{
Hashtable acts = new Hashtable(actions.length);
for (int i = 0; i < actions.length; ++i)
acts.put(actions[i].getValue(Action.NAME), actions[i]);
for (int i = 0; i < bindings.length; ++i)
if (acts.containsKey(bindings[i].actionName))
map.addActionForKeyStroke(bindings[i].key, (Action) acts.get(bindings[i].actionName));
}
/**
* Returns the set of available Actions this component's associated
* editor can run. Equivalent to calling
* getUI().getEditorKit().getActions(). This set of Actions
* is a reasonable value to provide as a parameter to {@link
* #loadKeymap}, when resolving a set of {@link KeyBinding} objects
* against this component.
*
* @return The set of available Actions on this component's {@link EditorKit}
*
* @see TextUI#getEditorKit
* @see EditorKit#getActions()
*/
public Action[] getActions()
{
return getUI().getEditorKit(this).getActions();
}
// These are package-private to avoid an accessor method.
Document doc;
Caret caret;
boolean editable;
private Highlighter highlighter;
private Color caretColor;
private Color disabledTextColor;
private Color selectedTextColor;
private Color selectionColor;
private Insets margin;
private boolean dragEnabled;
/**
* Creates a new JTextComponent instance.
*/
public JTextComponent()
{
Keymap defkeymap = getKeymap(DEFAULT_KEYMAP);
if (defkeymap == null)
{
defkeymap = addKeymap(DEFAULT_KEYMAP, null);
defkeymap.setDefaultAction(new DefaultEditorKit.DefaultKeyTypedAction());
}
setFocusable(true);
setEditable(true);
enableEvents(AWTEvent.KEY_EVENT_MASK);
updateUI();
}
public void setDocument(Document newDoc)
{
Document oldDoc = doc;
doc = newDoc;
firePropertyChange("document", oldDoc, newDoc);
revalidate();
repaint();
}
public Document getDocument()
{
return doc;
}
/**
* Get the AccessibleContext of this object.
*
* @return an AccessibleContext object
*/
public AccessibleContext getAccessibleContext()
{
return new AccessibleJTextComponent();
}
public void setMargin(Insets m)
{
margin = m;
}
public Insets getMargin()
{
return margin;
}
public void setText(String text)
{
try
{
if (doc instanceof AbstractDocument)
((AbstractDocument) doc).replace(0, doc.getLength(), text, null);
else
{
doc.remove(0, doc.getLength());
doc.insertString(0, text, null);
}
}
catch (BadLocationException e)
{
// This can never happen.
}
}
/**
* Retrieves the current text in this text document.
*
* @return the text
*
* @exception NullPointerException if the underlaying document is null
*/
public String getText()
{
if (doc == null)
return null;
try
{
return doc.getText(0, doc.getLength());
}
catch (BadLocationException e)
{
// This should never happen.
return "";
}
}
/**
* Retrieves a part of the current text in this document.
*
* @param offset the postion of the first character
* @param length the length of the text to retrieve
*
* @return the text
*
* @exception BadLocationException if arguments do not hold pre-conditions
*/
public String getText(int offset, int length)
throws BadLocationException
{
return getDocument().getText(offset, length);
}
/**
* Retrieves the currently selected text in this text document.
*
* @return the selected text
*
* @exception NullPointerException if the underlaying document is null
*/
public String getSelectedText()
{
int start = getSelectionStart();
int offset = getSelectionEnd() - start;
if (offset <= 0)
return null;
try
{
return doc.getText(start, offset);
}
catch (BadLocationException e)
{
// This should never happen.
return null;
}
}
/**
* Returns a string that specifies the name of the Look and Feel class
* that renders this component.
*
* @return the string "TextComponentUI"
*/
public String getUIClassID()
{
return "TextComponentUI";
}
/**
* Returns a string representation of this JTextComponent.
*/
protected String paramString()
{
// TODO: Do something useful here.
return super.paramString();
}
/**
* This method returns the label's UI delegate.
*
* @return The label's UI delegate.
*/
public TextUI getUI()
{
return (TextUI) ui;
}
/**
* This method sets the label's UI delegate.
*
* @param newUI The label's UI delegate.
*/
public void setUI(TextUI newUI)
{
super.setUI(newUI);
}
/**
* This method resets the label's UI delegate to the default UI for the
* current look and feel.
*/
public void updateUI()
{
setUI((TextUI) UIManager.getUI(this));
}
public Dimension getPreferredScrollableViewportSize()
{
return getPreferredSize();
}
public int getScrollableUnitIncrement(Rectangle visible, int orientation,
int direction)
{
// We return 1/10 of the visible area as documented in Sun's API docs.
if (orientation == SwingConstants.HORIZONTAL)
return visible.width / 10;
else if (orientation == SwingConstants.VERTICAL)
return visible.height / 10;
else
throw new IllegalArgumentException("orientation must be either "
+ "javax.swing.SwingConstants.VERTICAL "
+ "or "
+ "javax.swing.SwingConstants.HORIZONTAL"
);
}
public int getScrollableBlockIncrement(Rectangle visible, int orientation,
int direction)
{
// We return the whole visible area as documented in Sun's API docs.
if (orientation == SwingConstants.HORIZONTAL)
return visible.width;
else if (orientation == SwingConstants.VERTICAL)
return visible.height;
else
throw new IllegalArgumentException("orientation must be either "
+ "javax.swing.SwingConstants.VERTICAL "
+ "or "
+ "javax.swing.SwingConstants.HORIZONTAL"
);
}
/**
* Checks whether this text component it editable.
*
* @return true if editable, false otherwise
*/
public boolean isEditable()
{
return editable;
}
/**
* Enables/disabled this text component's editability.
*
* @param newValue true to make it editable, false otherwise.
*/
public void setEditable(boolean newValue)
{
if (editable == newValue)
return;
boolean oldValue = editable;
editable = newValue;
firePropertyChange("editable", oldValue, newValue);
}
/**
* The Caret object used in this text component.
*
* @return the caret object
*/
public Caret getCaret()
{
return caret;
}
/**
* Sets a new Caret for this text component.
*
* @param newCaret the new Caret to set
*/
public void setCaret(Caret newCaret)
{
if (caret != null)
caret.deinstall(this);
Caret oldCaret = caret;
caret = newCaret;
if (caret != null)
caret.install(this);
firePropertyChange("caret", oldCaret, newCaret);
}
public Color getCaretColor()
{
return caretColor;
}
public void setCaretColor(Color newColor)
{
Color oldCaretColor = caretColor;
caretColor = newColor;
firePropertyChange("caretColor", oldCaretColor, newColor);
}
public Color getDisabledTextColor()
{
return disabledTextColor;
}
public void setDisabledTextColor(Color newColor)
{
Color oldColor = disabledTextColor;
disabledTextColor = newColor;
firePropertyChange("disabledTextColor", oldColor, newColor);
}
public Color getSelectedTextColor()
{
return selectedTextColor;
}
public void setSelectedTextColor(Color newColor)
{
Color oldColor = selectedTextColor;
selectedTextColor = newColor;
firePropertyChange("selectedTextColor", oldColor, newColor);
}
public Color getSelectionColor()
{
return selectionColor;
}
public void setSelectionColor(Color newColor)
{
Color oldColor = selectionColor;
selectionColor = newColor;
firePropertyChange("selectionColor", oldColor, newColor);
}
/**
* Retrisves the current caret position.
*
* @return the current position
*/
public int getCaretPosition()
{
return caret.getDot();
}
/**
* Sets the caret to a new position.
*
* @param position the new position
*/
public void setCaretPosition(int position)
{
if (doc == null)
return;
if (position < 0 || position > doc.getLength())
throw new IllegalArgumentException();
caret.setDot(position);
}
/**
* Moves the caret to a given position. This selects the text between
* the old and the new position of the caret.
*/
public void moveCaretPosition(int position)
{
if (doc == null)
return;
if (position < 0 || position > doc.getLength())
throw new IllegalArgumentException();
caret.moveDot(position);
}
public Highlighter getHighlighter()
{
return highlighter;
}
public void setHighlighter(Highlighter newHighlighter)
{
if (highlighter != null)
highlighter.deinstall(this);
Highlighter oldHighlighter = highlighter;
highlighter = newHighlighter;
if (highlighter != null)
highlighter.install(this);
firePropertyChange("highlighter", oldHighlighter, newHighlighter);
}
/**
* Returns the start postion of the currently selected text.
*
* @return the start postion
*/
public int getSelectionStart()
{
return Math.min(caret.getDot(), caret.getMark());
}
/**
* Selects the text from the given postion to the selection end position.
*
* @param start the start positon of the selected text.
*/
public void setSelectionStart(int start)
{
select(start, getSelectionEnd());
}
/**
* Returns the end postion of the currently selected text.
*
* @return the end postion
*/
public int getSelectionEnd()
{
return Math.max(caret.getDot(), caret.getMark());
}
/**
* Selects the text from the selection start postion to the given position.
*
* @param end the end positon of the selected text.
*/
public void setSelectionEnd(int end)
{
select(getSelectionStart(), end);
}
/**
* Selects a part of the content of the text component.
*
* @param start the start position of the selected text
* @param end the end position of the selected text
*/
public void select(int start, int end)
{
int length = doc.getLength();
start = Math.max(start, 0);
start = Math.min(start, length);
end = Math.max(end, start);
end = Math.min(end, length);
setCaretPosition(start);
moveCaretPosition(end);
}
/**
* Selects the whole content of the text component.
*/
public void selectAll()
{
select(0, doc.getLength());
}
public synchronized void replaceSelection(String content)
{
int dot = caret.getDot();
int mark = caret.getMark();
// If content is empty delete selection.
if (content == null)
{
caret.setDot(dot);
return;
}
try
{
int start = getSelectionStart();
int end = getSelectionEnd();
// Remove selected text.
if (dot != mark)
doc.remove(start, end - start);
// Insert new text.
doc.insertString(start, content, null);
// Set dot to new position,
dot = start + content.length();
setCaretPosition(dot);
// and update it's magic position.
caret.setMagicCaretPosition(modelToView(dot).getLocation());
}
catch (BadLocationException e)
{
// This should never happen.
}
}
public boolean getScrollableTracksViewportHeight()
{
if (getParent() instanceof JViewport)
return getParent().getHeight() > getPreferredSize().height;
return false;
}
public boolean getScrollableTracksViewportWidth()
{
if (getParent() instanceof JViewport)
return getParent().getWidth() > getPreferredSize().width;
return false;
}
/**
* Adds a CaretListener object to this text component.
*
* @param listener the listener to add
*/
public void addCaretListener(CaretListener listener)
{
listenerList.add(CaretListener.class, listener);
}
/**
* Removed a CaretListener object from this text component.
*
* @param listener the listener to remove
*/
public void removeCaretListener(CaretListener listener)
{
listenerList.remove(CaretListener.class, listener);
}
/**
* Returns all added CaretListener objects.
*
* @return an array of listeners
*/
public CaretListener[] getCaretListeners()
{
return (CaretListener[]) getListeners(CaretListener.class);
}
/**
* Notifies all registered CaretListener objects that the caret
* was updated.
*
* @param event the event to send
*/
protected void fireCaretUpdate(CaretEvent event)
{
CaretListener[] listeners = getCaretListeners();
for (int index = 0; index < listeners.length; ++index)
listeners[index].caretUpdate(event);
}
/**
* Adds an InputListener object to this text component.
*
* @param listener the listener to add
*/
public void addInputMethodListener(InputMethodListener listener)
{
listenerList.add(InputMethodListener.class, listener);
}
/**
* Removes an InputListener object from this text component.
*
* @param listener the listener to remove
*/
public void removeInputMethodListener(InputMethodListener listener)
{
listenerList.remove(InputMethodListener.class, listener);
}
/**
* Returns all added InputMethodListener objects.
*
* @return an array of listeners
*/
public InputMethodListener[] getInputMethodListeners()
{
return (InputMethodListener[]) getListeners(InputMethodListener.class);
}
public Rectangle modelToView(int position) throws BadLocationException
{
return getUI().modelToView(this, position);
}
public boolean getDragEnabled()
{
return dragEnabled;
}
public void setDragEnabled(boolean enabled)
{
dragEnabled = enabled;
}
public int viewToModel(Point pt)
{
return getUI().viewToModel(this, pt);
}
public void copy()
{
doTransferAction("copy", TransferHandler.getCopyAction());
}
public void cut()
{
doTransferAction("cut", TransferHandler.getCutAction());
}
public void paste()
{
doTransferAction("paste", TransferHandler.getPasteAction());
}
private void doTransferAction(String name, Action action)
{
// Install default TransferHandler if none set.
if (getTransferHandler() == null)
{
if (defaultTransferHandler == null)
defaultTransferHandler = new DefaultTransferHandler();
setTransferHandler(defaultTransferHandler);
}
// Perform action.
ActionEvent event = new ActionEvent(this, ActionEvent.ACTION_PERFORMED,
action.getValue(Action.NAME).toString());
action.actionPerformed(event);
}
public void setFocusAccelerator(char newKey)
{
if (focusAccelerator == newKey)
return;
char oldKey = focusAccelerator;
focusAccelerator = newKey;
firePropertyChange(FOCUS_ACCELERATOR_KEY, oldKey, newKey);
}
public char getFocusAccelerator()
{
return focusAccelerator;
}
/**
* @since 1.4
*/
public NavigationFilter getNavigationFilter()
{
return navigationFilter;
}
/**
* @since 1.4
*/
public void setNavigationFilter(NavigationFilter filter)
{
navigationFilter = filter;
}
/**
* Read and set the content this component. If not overridden, the
* method reads the component content as a plain text.
*
* The second parameter of this method describes the input stream. It can
* be String, URL, File and so on. If not null, this object is added to
* the properties of the associated document under the key
* {@link Document#StreamDescriptionProperty}.
*
* @param input an input stream to read from.
* @param streamDescription an object, describing the stream.
*
* @throws IOException if the reader throws it.
*
* @see #getDocument()
* @see Document#getProperty(Object)
*/
public void read(Reader input, Object streamDescription)
throws IOException
{
if (streamDescription != null)
{
Document d = getDocument();
if (d != null)
d.putProperty(Document.StreamDescriptionProperty, streamDescription);
}
StringBuffer b = new StringBuffer();
int c;
// Read till -1 (EOF).
while ((c = input.read()) >= 0)
b.append((char) c);
setText(b.toString());
}
/**
* Write the content of this component to the given stream. If not
* overridden, the method writes the component content as a plain text.
*
* @param output the writer to write into.
*
* @throws IOException if the writer throws it.
*/
public void write(Writer output)
throws IOException
{
output.write(getText());
}
/**
* Returns the tooltip text for this text component for the given mouse
* event. This forwards the call to
* {@link TextUI#getToolTipText(JTextComponent, Point)}.
*
* @param ev the mouse event
*
* @return the tooltip text for this text component for the given mouse
* event
*/
public String getToolTipText(MouseEvent ev)
{
return getUI().getToolTipText(this, ev.getPoint());
}
}