| Method from javax.swing.text.JTextComponent Detail: |
|---|
 public void addCaretListener(CaretListener listener) {
listenerList.add(CaretListener.class, listener);
}
Adds a caret listener for notification of any changes
to the caret. |
public void addInputMethodListener(InputMethodListener l) {
super.addInputMethodListener(l);
if (l != null) {
needToSendKeyTypedEvent = false;
checkedInputOverride = true;
}
} |
public static Keymap addKeymap(String nm,
Keymap parent) {
Keymap map = new DefaultKeymap(nm, parent);
if (nm != null) {
// add a named keymap, a class of bindings
getKeymapTable().put(nm, map);
}
return map;
} Adds a new keymap into the keymap hierarchy. Keymap bindings
resolve from bottom up so an attribute specified in a child
will override an attribute specified in the parent. |
boolean composedTextExists() {
return (composedTextStart != null);
} |
public void copy() {
invokeAction("copy", TransferHandler.getCopyAction());
} Transfers the currently selected range in the associated
text model to the system clipboard, leaving the contents
in the text model. The current selection remains intact.
Does nothing for null selections. |
public void cut() {
if (isEditable() && isEnabled()) {
invokeAction("cut", TransferHandler.getCutAction());
}
} Transfers the currently selected range in the associated
text model to the system clipboard, removing the contents
from the model. The current selection is reset. Does nothing
for null selections. |
DropLocation dropLocationForPoint(Point p) {
Position.Bias[] bias = new Position.Bias[1];
int index = getUI().viewToModel(this, p, bias);
// viewToModel currently returns null for some HTML content
// when the point is within the component's top inset
if (bias[0] == null) {
bias[0] = Position.Bias.Forward;
}
return new DropLocation(p, index, bias[0]);
} Calculates a drop location in this component, representing where a
drop at the given point should insert data.
Note: This method is meant to override
JComponent.dropLocationForPoint(), which is package-private
in javax.swing. TransferHandler will detect text components
and call this method instead via reflection. It's name should therefore
not be changed. |
protected void fireCaretUpdate(CaretEvent e) {
// Guaranteed to return a non-null array
Object[] listeners = listenerList.getListenerList();
// Process the listeners last to first, notifying
// those that are interested in this event
for (int i = listeners.length-2; i >=0; i-=2) {
if (listeners[i]==CaretListener.class) {
((CaretListener)listeners[i+1]).caretUpdate(e);
}
}
} Notifies all listeners that have registered interest for
notification on this event type. The event instance
is lazily created using the parameters passed into
the fire method. The listener list is processed in a
last-to-first manner. |
public AccessibleContext getAccessibleContext() {
if (accessibleContext == null) {
accessibleContext = new AccessibleJTextComponent();
}
return accessibleContext;
} Gets the AccessibleContext associated with this
JTextComponent. For text components,
the AccessibleContext takes the form of an
AccessibleJTextComponent.
A new AccessibleJTextComponent instance
is created if necessary. |
public Action[] getActions() {
return getUI().getEditorKit(this).getActions();
} Fetches the command list for the editor. This is
the list of commands supported by the plugged-in UI
augmented by the collection of commands that the
editor itself supports. These are useful for binding
to events, such as in a keymap. |
public Caret getCaret() {
return caret;
} Fetches the caret that allows text-oriented navigation over
the view. |
public Color getCaretColor() {
return caretColor;
} Fetches the current color used to render the
caret. |
public CaretListener[] getCaretListeners() {
return listenerList.getListeners(CaretListener.class);
} Returns an array of all the caret listeners
registered on this text component. |
public int getCaretPosition() {
return caret.getDot();
} Returns the position of the text insertion caret for the
text component. |
public Color getDisabledTextColor() {
return disabledTextColor;
} Fetches the current color used to render the
disabled text. |
public Document getDocument() {
return model;
} Fetches the model associated with the editor. This is
primarily for the UI to get at the minimal amount of
state required to be a text editor. Subclasses will
return the actual type of the model which will typically
be something that extends Document. |
public boolean getDragEnabled() {
return dragEnabled;
} Returns whether or not automatic drag handling is enabled. |
public final DropLocation getDropLocation() {
return dropLocation;
} Returns the location that this component should visually indicate
as the drop location during a DnD operation over the component,
or {@code null} if no location is to currently be shown.
This method is not meant for querying the drop location
from a {@code TransferHandler}, as the drop location is only
set after the {@code TransferHandler}'s canImport
has returned and has allowed for the location to be shown.
When this property changes, a property change event with
name "dropLocation" is fired by the component. |
public final DropMode getDropMode() {
return dropMode;
} Returns the drop mode for this component. |
public char getFocusAccelerator() {
return focusAccelerator;
} Returns the key accelerator that will cause the receiving
text component to get the focus. Return '\0' if no focus
accelerator has been set. |
static final JTextComponent getFocusedComponent() {
return (JTextComponent)AppContext.getAppContext().
get(FOCUSED_COMPONENT);
} Returns the JTextComponent that most recently had focus. The returned
value may currently have focus. |
public Highlighter getHighlighter() {
return highlighter;
} Fetches the object responsible for making highlights. |
public InputMethodRequests getInputMethodRequests() {
if (inputMethodRequestsHandler == null) {
inputMethodRequestsHandler = new InputMethodRequestsHandler();
Document doc = getDocument();
if (doc != null) {
doc.addDocumentListener((DocumentListener)inputMethodRequestsHandler);
}
}
return inputMethodRequestsHandler;
} |
public Keymap getKeymap() {
return keymap;
} Fetches the keymap currently active in this text
component. |
public static Keymap getKeymap(String nm) {
return getKeymapTable().get(nm);
} Fetches a named keymap previously added to the document.
This does not work with null-named keymaps. |
public Insets getMargin() {
return margin;
} Returns the margin between the text component's border and
its text. |
public NavigationFilter getNavigationFilter() {
return navigationFilter;
} Returns the NavigationFilter. NavigationFilter
is used by DefaultCaret and the default cursor movement
actions as a way to restrict the cursor movement. A null return value
implies the cursor movement and selection should not be restricted. |
public Dimension getPreferredScrollableViewportSize() {
return getPreferredSize();
} Returns the preferred size of the viewport for a view component.
This is implemented to do the default behavior of returning
the preferred size of the component. |
public Printable getPrintable(MessageFormat headerFormat,
MessageFormat footerFormat) {
return TextComponentPrintable.getPrintable(
this, headerFormat, footerFormat);
} Returns a {@code Printable} to use for printing the content of this
{@code JTextComponent}. The returned {@code Printable} prints
the document as it looks on the screen except being reformatted
to fit the paper.
The returned {@code Printable} can be wrapped inside another
{@code Printable} in order to create complex reports and
documents.
The returned {@code Printable} shares the {@code document} with this
{@code JTextComponent}. It is the responsibility of the developer to
ensure that the {@code document} is not mutated while this {@code Printable}
is used. Printing behavior is undefined when the {@code document} is
mutated during printing.
Page header and footer text can be added to the output by providing
{@code MessageFormat} arguments. The printing code requests
{@code Strings} from the formats, providing a single item which may be
included in the formatted string: an {@code Integer} representing the
current page number.
The returned {@code Printable} when printed, formats the
document content appropriately for the page size. For correct
line wrapping the {@code imageable width} of all pages must be the
same. See java.awt.print.PageFormat#getImageableWidth .
This method is thread-safe, although most Swing methods are not. Please
see
How to Use Threads for more information.
The returned {@code Printable} can be printed on any thread.
This implementation returned {@code Printable} performs all painting on
the Event Dispatch Thread, regardless of what thread it is
used on. |
public int getScrollableBlockIncrement(Rectangle visibleRect,
int orientation,
int direction) {
switch(orientation) {
case SwingConstants.VERTICAL:
return visibleRect.height;
case SwingConstants.HORIZONTAL:
return visibleRect.width;
default:
throw new IllegalArgumentException("Invalid orientation: " + orientation);
}
} Components that display logical rows or columns should compute
the scroll increment that will completely expose one block
of rows or columns, depending on the value of orientation.
The default implementation of this is to simply return the visible
area. Subclasses will likely be able to provide a much more
reasonable value. |
public boolean getScrollableTracksViewportHeight() {
Container parent = SwingUtilities.getUnwrappedParent(this);
if (parent instanceof JViewport) {
return parent.getHeight() > getPreferredSize().height;
}
return false;
} Returns true if a viewport should always force the height of this
Scrollable to match the height of the viewport.
For example a columnar text view that flowed text in left to
right columns could effectively disable vertical scrolling by
returning true here.
Scrolling containers, like JViewport,
will use this method each time they are validated. |
public boolean getScrollableTracksViewportWidth() {
Container parent = SwingUtilities.getUnwrappedParent(this);
if (parent instanceof JViewport) {
return parent.getWidth() > getPreferredSize().width;
}
return false;
} Returns true if a viewport should always force the width of this
Scrollable to match the width of the viewport.
For example a normal text view that supported line wrapping
would return true here, since it would be undesirable for
wrapped lines to disappear beyond the right
edge of the viewport. Note that returning true for a
Scrollable whose ancestor is a JScrollPane
effectively disables horizontal scrolling.
Scrolling containers, like JViewport,
will use this method each time they are validated. |
public int getScrollableUnitIncrement(Rectangle visibleRect,
int orientation,
int direction) {
switch(orientation) {
case SwingConstants.VERTICAL:
return visibleRect.height / 10;
case SwingConstants.HORIZONTAL:
return visibleRect.width / 10;
default:
throw new IllegalArgumentException("Invalid orientation: " + orientation);
}
} Components that display logical rows or columns should compute
the scroll increment that will completely expose one new row
or column, depending on the value of orientation. Ideally,
components should handle a partially exposed row or column by
returning the distance required to completely expose the item.
The default implementation of this is to simply return 10% of
the visible area. Subclasses are likely to be able to provide
a much more reasonable value. |
public String getSelectedText() {
String txt = null;
int p0 = Math.min(caret.getDot(), caret.getMark());
int p1 = Math.max(caret.getDot(), caret.getMark());
if (p0 != p1) {
try {
Document doc = getDocument();
txt = doc.getText(p0, p1 - p0);
} catch (BadLocationException e) {
throw new IllegalArgumentException(e.getMessage());
}
}
return txt;
} Returns the selected text contained in this
TextComponent. If the selection is
null or the document empty, returns null. |
public Color getSelectedTextColor() {
return selectedTextColor;
} Fetches the current color used to render the
selected text. |
public Color getSelectionColor() {
return selectionColor;
} Fetches the current color used to render the
selection. |
public int getSelectionEnd() {
int end = Math.max(caret.getDot(), caret.getMark());
return end;
} Returns the selected text's end position. Return 0 if the document
is empty, or the value of dot if there is no selection. |
public int getSelectionStart() {
int start = Math.min(caret.getDot(), caret.getMark());
return start;
} Returns the selected text's start position. Return 0 for an
empty document, or the value of dot if no selection. |
public String getText() {
Document doc = getDocument();
String txt;
try {
txt = doc.getText(0, doc.getLength());
} catch (BadLocationException e) {
txt = null;
}
return txt;
} Returns the text contained in this TextComponent.
If the underlying document is null,
will give a NullPointerException.
Note that text is not a bound property, so no PropertyChangeEvent
is fired when it changes. To listen for changes to the text,
use DocumentListener. |
public String getText(int offs,
int len) throws BadLocationException {
return getDocument().getText(offs, len);
} Fetches a portion of the text represented by the
component. Returns an empty string if length is 0. |
public String getToolTipText(MouseEvent event) {
String retValue = super.getToolTipText(event);
if (retValue == null) {
TextUI ui = getUI();
if (ui != null) {
retValue = ui.getToolTipText(this, new Point(event.getX(),
event.getY()));
}
}
return retValue;
} Returns the string to be used as the tooltip for event.
This will return one of:
- If
setToolTipText has been invoked with a
non-null
value, it will be returned, otherwise
- The value from invoking
getToolTipText on
the UI will be returned.
By default JTextComponent does not register
itself with the ToolTipManager.
This means that tooltips will NOT be shown from the
TextUI unless registerComponent has
been invoked on the ToolTipManager. |
public TextUI getUI() {
return (TextUI)ui;
} Fetches the user-interface factory for this text-oriented editor. |
public boolean isEditable() {
return editable;
} Returns the boolean indicating whether this
TextComponent is editable or not. |
public static void loadKeymap(Keymap map,
KeyBinding[] bindings,
Action[] actions) {
Hashtable< String, Action > h = new Hashtable< String, Action >();
for (Action a : actions) {
String value = (String)a.getValue(Action.NAME);
h.put((value!=null ? value:""), a);
}
for (KeyBinding binding : bindings) {
Action a = h.get(binding.actionName);
if (a != null) {
map.addActionForKeyStroke(binding.key, a);
}
}
}
Loads a keymap with a bunch of
bindings. This can be used to take a static table of
definitions and load them into some keymap. The following
example illustrates an example of binding some keys to
the cut, copy, and paste actions associated with a
JTextComponent. A code fragment to accomplish
this might look as follows:
static final JTextComponent.KeyBinding[] defaultBindings = {
new JTextComponent.KeyBinding(
KeyStroke.getKeyStroke(KeyEvent.VK_C, InputEvent.CTRL_MASK),
DefaultEditorKit.copyAction),
new JTextComponent.KeyBinding(
KeyStroke.getKeyStroke(KeyEvent.VK_V, InputEvent.CTRL_MASK),
DefaultEditorKit.pasteAction),
new JTextComponent.KeyBinding(
KeyStroke.getKeyStroke(KeyEvent.VK_X, InputEvent.CTRL_MASK),
DefaultEditorKit.cutAction),
};
JTextComponent c = new JTextPane();
Keymap k = c.getKeymap();
JTextComponent.loadKeymap(k, defaultBindings, c.getActions());
The sets of bindings and actions may be empty but must be
non-null. |
public Rectangle modelToView(int pos) throws BadLocationException {
return getUI().modelToView(this, pos);
} Converts the given location in the model to a place in
the view coordinate system.
The component must have a positive size for
this translation to be computed (i.e. layout cannot
be computed until the component has been sized). The
component does not have to be visible or painted. |
public void moveCaretPosition(int pos) {
Document doc = getDocument();
if (doc != null) {
if (pos > doc.getLength() || pos < 0) {
throw new IllegalArgumentException("bad position: " + pos);
}
caret.moveDot(pos);
}
} Moves the caret to a new position, leaving behind a mark
defined by the last time setCaretPosition was
called. This forms a selection.
If the document is null, does nothing. The position
must be between 0 and the length of the component's text or else
an exception is thrown. |
protected String paramString() {
String editableString = (editable ?
"true" : "false");
String caretColorString = (caretColor != null ?
caretColor.toString() : "");
String selectionColorString = (selectionColor != null ?
selectionColor.toString() : "");
String selectedTextColorString = (selectedTextColor != null ?
selectedTextColor.toString() : "");
String disabledTextColorString = (disabledTextColor != null ?
disabledTextColor.toString() : "");
String marginString = (margin != null ?
margin.toString() : "");
return super.paramString() +
",caretColor=" + caretColorString +
",disabledTextColor=" + disabledTextColorString +
",editable=" + editableString +
",margin=" + marginString +
",selectedTextColor=" + selectedTextColorString +
",selectionColor=" + selectionColorString;
} |
public void paste() {
if (isEditable() && isEnabled()) {
invokeAction("paste", TransferHandler.getPasteAction());
}
} Transfers the contents of the system clipboard into the
associated text model. If there is a selection in the
associated view, it is replaced with the contents of the
clipboard. If there is no selection, the clipboard contents
are inserted in front of the current insert position in
the associated view. If the clipboard is empty, does nothing. |
public boolean print() throws PrinterException {
return print(null, null, true, null, null, true);
} A convenience print method that displays a print dialog, and then
prints this {@code JTextComponent} in interactive mode with no
header or footer text. Note: this method
blocks until printing is done.
Note: In headless mode, no dialogs will be shown.
This method calls the full featured
MessageFormat, boolean, PrintService, PrintRequestAttributeSet, boolean)
print method to perform printing. |
public boolean print(MessageFormat headerFormat,
MessageFormat footerFormat) throws PrinterException {
return print(headerFormat, footerFormat, true, null, null, true);
} A convenience print method that displays a print dialog, and then
prints this {@code JTextComponent} in interactive mode with
the specified header and footer text. Note: this method
blocks until printing is done.
Note: In headless mode, no dialogs will be shown.
This method calls the full featured
MessageFormat, boolean, PrintService, PrintRequestAttributeSet, boolean)
print method to perform printing. |
public boolean print(MessageFormat headerFormat,
MessageFormat footerFormat,
boolean showPrintDialog,
PrintService service,
PrintRequestAttributeSet attributes,
boolean interactive) throws PrinterException {
final PrinterJob job = PrinterJob.getPrinterJob();
final Printable printable;
final PrintingStatus printingStatus;
final boolean isHeadless = GraphicsEnvironment.isHeadless();
final boolean isEventDispatchThread =
SwingUtilities.isEventDispatchThread();
final Printable textPrintable = getPrintable(headerFormat, footerFormat);
if (interactive && ! isHeadless) {
printingStatus =
PrintingStatus.createPrintingStatus(this, job);
printable =
printingStatus.createNotificationPrintable(textPrintable);
} else {
printingStatus = null;
printable = textPrintable;
}
if (service != null) {
job.setPrintService(service);
}
job.setPrintable(printable);
final PrintRequestAttributeSet attr = (attributes == null)
? new HashPrintRequestAttributeSet()
: attributes;
if (showPrintDialog && ! isHeadless && ! job.printDialog(attr)) {
return false;
}
/*
* there are three cases for printing:
* 1. print non interactively (! interactive || isHeadless)
* 2. print interactively off EDT
* 3. print interactively on EDT
*
* 1 and 2 prints on the current thread (3 prints on another thread)
* 2 and 3 deal with PrintingStatusDialog
*/
final Callable< Object > doPrint =
new Callable< Object >() {
public Object call() throws Exception {
try {
job.print(attr);
} finally {
if (printingStatus != null) {
printingStatus.dispose();
}
}
return null;
}
};
final FutureTask< Object > futurePrinting =
new FutureTask< Object >(doPrint);
final Runnable runnablePrinting =
new Runnable() {
public void run() {
//disable component
boolean wasEnabled = false;
if (isEventDispatchThread) {
if (isEnabled()) {
wasEnabled = true;
setEnabled(false);
}
} else {
try {
wasEnabled = SwingUtilities2.submit(
new Callable< Boolean >() {
public Boolean call() throws Exception {
boolean rv = isEnabled();
if (rv) {
setEnabled(false);
}
return rv;
}
}).get();
} catch (InterruptedException e) {
throw new RuntimeException(e);
} catch (ExecutionException e) {
Throwable cause = e.getCause();
if (cause instanceof Error) {
throw (Error) cause;
}
if (cause instanceof RuntimeException) {
throw (RuntimeException) cause;
}
throw new AssertionError(cause);
}
}
getDocument().render(futurePrinting);
//enable component
if (wasEnabled) {
if (isEventDispatchThread) {
setEnabled(true);
} else {
try {
SwingUtilities2.submit(
new Runnable() {
public void run() {
setEnabled(true);
}
}, null).get();
} catch (InterruptedException e) {
throw new RuntimeException(e);
} catch (ExecutionException e) {
Throwable cause = e.getCause();
if (cause instanceof Error) {
throw (Error) cause;
}
if (cause instanceof RuntimeException) {
throw (RuntimeException) cause;
}
throw new AssertionError(cause);
}
}
}
}
};
if (! interactive || isHeadless) {
runnablePrinting.run();
} else {
if (isEventDispatchThread) {
(new Thread(runnablePrinting)).start();
printingStatus.showModal(true);
} else {
printingStatus.showModal(false);
runnablePrinting.run();
}
}
//the printing is done successfully or otherwise.
//dialog is hidden if needed.
try {
futurePrinting.get();
} catch (InterruptedException e) {
throw new RuntimeException(e);
} catch (ExecutionException e) {
Throwable cause = e.getCause();
if (cause instanceof PrinterAbortException) {
if (printingStatus != null
&& printingStatus.isAborted()) {
return false;
} else {
throw (PrinterAbortException) cause;
}
} else if (cause instanceof PrinterException) {
throw (PrinterException) cause;
} else if (cause instanceof RuntimeException) {
throw (RuntimeException) cause;
} else if (cause instanceof Error) {
throw (Error) cause;
} else {
throw new AssertionError(cause);
}
}
return true;
} Prints the content of this {@code JTextComponent}. Note: this method
blocks until printing is done.
Page header and footer text can be added to the output by providing
{@code MessageFormat} arguments. The printing code requests
{@code Strings} from the formats, providing a single item which may be
included in the formatted string: an {@code Integer} representing the
current page number.
{@code showPrintDialog boolean} parameter allows you to specify whether
a print dialog is displayed to the user. When it is, the user
may use the dialog to change printing attributes or even cancel the
print.
{@code service} allows you to provide the initial
{@code PrintService} for the print dialog, or to specify
{@code PrintService} to print to when the dialog is not shown.
{@code attributes} can be used to provide the
initial values for the print dialog, or to supply any needed
attributes when the dialog is not shown. {@code attributes} can
be used to control how the job will print, for example
duplex or single-sided.
{@code interactive boolean} parameter allows you to specify
whether to perform printing in interactive
mode. If {@code true}, a progress dialog, with an abort option,
is displayed for the duration of printing. This dialog is
modal when {@code print} is invoked on the Event Dispatch
Thread and non-modal otherwise. Warning:
calling this method on the Event Dispatch Thread with {@code
interactive false} blocks all events, including repaints, from
being processed until printing is complete. It is only
recommended when printing from an application with no
visible GUI.
Note: In headless mode, {@code showPrintDialog} and
{@code interactive} parameters are ignored and no dialogs are
shown.
This method ensures the {@code document} is not mutated during printing.
To indicate it visually, {@code setEnabled(false)} is set for the
duration of printing.
This method uses #getPrintable to render document content.
This method is thread-safe, although most Swing methods are not. Please
see
How to Use Threads for more information.
Sample Usage. This code snippet shows a cross-platform print
dialog and then prints the {@code JTextComponent} in interactive mode
unless the user cancels the dialog:
textComponent.print(new MessageFormat("My text component header"),
new MessageFormat("Footer. Page - {0}"), true, null, null, true);
Executing this code off the Event Dispatch Thread
performs printing on the background.
The following pattern might be used for background
printing:
FutureTask<Boolean> future =
new FutureTask<Boolean>(
new Callable<Boolean>() {
public Boolean call() {
return textComponent.print(.....);
}
});
executor.execute(future);
|
protected void processInputMethodEvent(InputMethodEvent e) {
// let listeners handle the events
super.processInputMethodEvent(e);
if (!e.isConsumed()) {
if (! isEditable()) {
return;
} else {
switch (e.getID()) {
case InputMethodEvent.INPUT_METHOD_TEXT_CHANGED:
replaceInputMethodText(e);
// fall through
case InputMethodEvent.CARET_POSITION_CHANGED:
setInputMethodCaretPosition(e);
break;
}
}
e.consume();
}
} |
public void read(Reader in,
Object desc) throws IOException {
EditorKit kit = getUI().getEditorKit(this);
Document doc = kit.createDefaultDocument();
if (desc != null) {
doc.putProperty(Document.StreamDescriptionProperty, desc);
}
try {
kit.read(in, doc, 0);
setDocument(doc);
} catch (BadLocationException e) {
throw new IOException(e.getMessage());
}
} Initializes from a stream. This creates a
model of the type appropriate for the component
and initializes the model from the stream.
By default this will load the model as plain
text. Previous contents of the model are discarded. |
public void removeCaretListener(CaretListener listener) {
listenerList.remove(CaretListener.class, listener);
} Removes a caret listener. |
public static Keymap removeKeymap(String nm) {
return getKeymapTable().remove(nm);
} Removes a named keymap previously added to the document. Keymaps
with null names may not be removed in this way. |
public void removeNotify() {
super.removeNotify();
if (getFocusedComponent() == this) {
AppContext.getAppContext().remove(FOCUSED_COMPONENT);
}
} |
public void replaceSelection(String content) {
Document doc = getDocument();
if (doc != null) {
try {
boolean composedTextSaved = saveComposedText(caret.getDot());
int p0 = Math.min(caret.getDot(), caret.getMark());
int p1 = Math.max(caret.getDot(), caret.getMark());
if (doc instanceof AbstractDocument) {
((AbstractDocument)doc).replace(p0, p1 - p0, content,null);
}
else {
if (p0 != p1) {
doc.remove(p0, p1 - p0);
}
if (content != null && content.length() > 0) {
doc.insertString(p0, content, null);
}
}
if (composedTextSaved) {
restoreComposedText();
}
} catch (BadLocationException e) {
UIManager.getLookAndFeel().provideErrorFeedback(JTextComponent.this);
}
}
} Replaces the currently selected content with new content
represented by the given string. If there is no selection
this amounts to an insert of the given text. If there
is no replacement text this amounts to a removal of the
current selection.
This is the method that is used by the default implementation
of the action for inserting content that gets bound to the
keymap actions. |
protected void restoreComposedText() {
Document doc = getDocument();
try {
doc.insertString(caret.getDot(),
composedTextContent,
composedTextAttribute);
composedTextStart = doc.createPosition(caret.getDot() -
composedTextContent.length());
composedTextEnd = doc.createPosition(caret.getDot());
} catch (BadLocationException ble) {}
} Restores composed text previously saved by {@code saveComposedText}.
The saved composed text is inserted back into the document. This method
should be invoked only if {@code saveComposedText} returns {@code true}. |
protected boolean saveComposedText(int pos) {
if (composedTextExists()) {
int start = composedTextStart.getOffset();
int len = composedTextEnd.getOffset() -
composedTextStart.getOffset();
if (pos >= start && pos < = start + len) {
try {
getDocument().remove(start, len);
return true;
} catch (BadLocationException ble) {}
}
}
return false;
} Saves composed text around the specified position.
The composed text (if any) around the specified position is saved
in a backing store and removed from the document. |
public void select(int selectionStart,
int selectionEnd) {
// argument adjustment done by java.awt.TextComponent
int docLength = getDocument().getLength();
if (selectionStart < 0) {
selectionStart = 0;
}
if (selectionStart > docLength) {
selectionStart = docLength;
}
if (selectionEnd > docLength) {
selectionEnd = docLength;
}
if (selectionEnd < selectionStart) {
selectionEnd = selectionStart;
}
setCaretPosition(selectionStart);
moveCaretPosition(selectionEnd);
} Selects the text between the specified start and end positions.
This method sets the start and end positions of the
selected text, enforcing the restriction that the start position
must be greater than or equal to zero. The end position must be
greater than or equal to the start position, and less than or
equal to the length of the text component's text.
If the caller supplies values that are inconsistent or out of
bounds, the method enforces these constraints silently, and
without failure. Specifically, if the start position or end
position is greater than the length of the text, it is reset to
equal the text length. If the start position is less than zero,
it is reset to zero, and if the end position is less than the
start position, it is reset to the start position.
This call is provided for backward compatibility.
It is routed to a call to setCaretPosition
followed by a call to moveCaretPosition.
The preferred way to manage selection is by calling
those methods directly. |
public void selectAll() {
Document doc = getDocument();
if (doc != null) {
setCaretPosition(0);
moveCaretPosition(doc.getLength());
}
} Selects all the text in the TextComponent.
Does nothing on a null or empty document. |
public void setCaret(Caret c) {
if (caret != null) {
caret.removeChangeListener(caretEvent);
caret.deinstall(this);
}
Caret old = caret;
caret = c;
if (caret != null) {
caret.install(this);
caret.addChangeListener(caretEvent);
}
firePropertyChange("caret", old, caret);
} Sets the caret to be used. By default this will be set
by the UI that gets installed. This can be changed to
a custom caret if desired. Setting the caret results in a
PropertyChange event ("caret") being fired. |
public void setCaretColor(Color c) {
Color old = caretColor;
caretColor = c;
firePropertyChange("caretColor", old, caretColor);
} Sets the current color used to render the caret.
Setting to null effectively restores the default color.
Setting the color results in a PropertyChange event ("caretColor")
being fired. |
public void setCaretPosition(int position) {
Document doc = getDocument();
if (doc != null) {
if (position > doc.getLength() || position < 0) {
throw new IllegalArgumentException("bad position: " + position);
}
caret.setDot(position);
}
} Sets the position of the text insertion caret for the
TextComponent. Note that the caret tracks change,
so this may move if the underlying text of the component is changed.
If the document is null, does nothing. The position
must be between 0 and the length of the component's text or else
an exception is thrown. |
public void setComponentOrientation(ComponentOrientation o) {
// Set the document's run direction property to match the
// ComponentOrientation property.
Document doc = getDocument();
if( doc != null ) {
Boolean runDir = o.isLeftToRight()
? TextAttribute.RUN_DIRECTION_LTR
: TextAttribute.RUN_DIRECTION_RTL;
doc.putProperty( TextAttribute.RUN_DIRECTION, runDir );
}
super.setComponentOrientation( o );
} |
public void setDisabledTextColor(Color c) {
Color old = disabledTextColor;
disabledTextColor = c;
firePropertyChange("disabledTextColor", old, disabledTextColor);
} Sets the current color used to render the
disabled text. Setting the color fires off a
PropertyChange event ("disabledTextColor"). |
public void setDocument(Document doc) {
Document old = model;
/*
* aquire a read lock on the old model to prevent notification of
* mutations while we disconnecting the old model.
*/
try {
if (old instanceof AbstractDocument) {
((AbstractDocument)old).readLock();
}
if (accessibleContext != null) {
model.removeDocumentListener(
((AccessibleJTextComponent)accessibleContext));
}
if (inputMethodRequestsHandler != null) {
model.removeDocumentListener((DocumentListener)inputMethodRequestsHandler);
}
model = doc;
// Set the document's run direction property to match the
// component's ComponentOrientation property.
Boolean runDir = getComponentOrientation().isLeftToRight()
? TextAttribute.RUN_DIRECTION_LTR
: TextAttribute.RUN_DIRECTION_RTL;
if (runDir != doc.getProperty(TextAttribute.RUN_DIRECTION)) {
doc.putProperty(TextAttribute.RUN_DIRECTION, runDir );
}
firePropertyChange("document", old, doc);
} finally {
if (old instanceof AbstractDocument) {
((AbstractDocument)old).readUnlock();
}
}
revalidate();
repaint();
if (accessibleContext != null) {
model.addDocumentListener(
((AccessibleJTextComponent)accessibleContext));
}
if (inputMethodRequestsHandler != null) {
model.addDocumentListener((DocumentListener)inputMethodRequestsHandler);
}
} Associates the editor with a text document.
The currently registered factory is used to build a view for
the document, which gets displayed by the editor after revalidation.
A PropertyChange event ("document") is propagated to each listener. |
public void setDragEnabled(boolean b) {
if (b && GraphicsEnvironment.isHeadless()) {
throw new HeadlessException();
}
dragEnabled = b;
} Turns on or off automatic drag handling. In order to enable automatic
drag handling, this property should be set to {@code true}, and the
component's {@code TransferHandler} needs to be {@code non-null}.
The default value of the {@code dragEnabled} property is {@code false}.
The job of honoring this property, and recognizing a user drag gesture,
lies with the look and feel implementation, and in particular, the component's
{@code TextUI}. When automatic drag handling is enabled, most look and
feels (including those that subclass {@code BasicLookAndFeel}) begin a
drag and drop operation whenever the user presses the mouse button over
a selection and then moves the mouse a few pixels. Setting this property to
{@code true} can therefore have a subtle effect on how selections behave.
If a look and feel is used that ignores this property, you can still
begin a drag and drop operation by calling {@code exportAsDrag} on the
component's {@code TransferHandler}. |
Object setDropLocation(DropLocation location,
Object state,
boolean forDrop) {
Object retVal = null;
DropLocation textLocation = (DropLocation)location;
if (dropMode == DropMode.USE_SELECTION) {
if (textLocation == null) {
if (state != null) {
/*
* This object represents the state saved earlier.
* If the caret is a DefaultCaret it will be
* an Object array containing, in order:
* - the saved caret mark (Integer)
* - the saved caret dot (Integer)
* - the saved caret visibility (Boolean)
* - the saved mark bias (Position.Bias)
* - the saved dot bias (Position.Bias)
* If the caret is not a DefaultCaret it will
* be similar, but will not contain the dot
* or mark bias.
*/
Object[] vals = (Object[])state;
if (!forDrop) {
if (caret instanceof DefaultCaret) {
((DefaultCaret)caret).setDot(((Integer)vals[0]).intValue(),
(Position.Bias)vals[3]);
((DefaultCaret)caret).moveDot(((Integer)vals[1]).intValue(),
(Position.Bias)vals[4]);
} else {
caret.setDot(((Integer)vals[0]).intValue());
caret.moveDot(((Integer)vals[1]).intValue());
}
}
caret.setVisible(((Boolean)vals[2]).booleanValue());
}
} else {
if (dropLocation == null) {
boolean visible;
if (caret instanceof DefaultCaret) {
DefaultCaret dc = (DefaultCaret)caret;
visible = dc.isActive();
retVal = new Object[] {Integer.valueOf(dc.getMark()),
Integer.valueOf(dc.getDot()),
Boolean.valueOf(visible),
dc.getMarkBias(),
dc.getDotBias()};
} else {
visible = caret.isVisible();
retVal = new Object[] {Integer.valueOf(caret.getMark()),
Integer.valueOf(caret.getDot()),
Boolean.valueOf(visible)};
}
caret.setVisible(true);
} else {
retVal = state;
}
if (caret instanceof DefaultCaret) {
((DefaultCaret)caret).setDot(textLocation.getIndex(), textLocation.getBias());
} else {
caret.setDot(textLocation.getIndex());
}
}
} else {
if (textLocation == null) {
if (state != null) {
caret.setVisible(((Boolean)state).booleanValue());
}
} else {
if (dropLocation == null) {
boolean visible = caret instanceof DefaultCaret
? ((DefaultCaret)caret).isActive()
: caret.isVisible();
retVal = Boolean.valueOf(visible);
caret.setVisible(false);
} else {
retVal = state;
}
}
}
DropLocation old = dropLocation;
dropLocation = textLocation;
firePropertyChange("dropLocation", old, dropLocation);
return retVal;
} Called to set or clear the drop location during a DnD operation.
In some cases, the component may need to use it's internal selection
temporarily to indicate the drop location. To help facilitate this,
this method returns and accepts as a parameter a state object.
This state object can be used to store, and later restore, the selection
state. Whatever this method returns will be passed back to it in
future calls, as the state parameter. If it wants the DnD system to
continue storing the same state, it must pass it back every time.
Here's how this is used:
Let's say that on the first call to this method the component decides
to save some state (because it is about to use the selection to show
a drop index). It can return a state object to the caller encapsulating
any saved selection state. On a second call, let's say the drop location
is being changed to something else. The component doesn't need to
restore anything yet, so it simply passes back the same state object
to have the DnD system continue storing it. Finally, let's say this
method is messaged with null. This means DnD
is finished with this component for now, meaning it should restore
state. At this point, it can use the state parameter to restore
said state, and of course return null since there's
no longer anything to store.
Note: This method is meant to override
JComponent.setDropLocation(), which is package-private
in javax.swing. TransferHandler will detect text components
and call this method instead via reflection. It's name should therefore
not be changed. |
public final void setDropMode(DropMode dropMode) {
if (dropMode != null) {
switch (dropMode) {
case USE_SELECTION:
case INSERT:
this.dropMode = dropMode;
return;
}
}
throw new IllegalArgumentException(dropMode + ": Unsupported drop mode for text");
} Sets the drop mode for this component. For backward compatibility,
the default for this property is DropMode.USE_SELECTION.
Usage of DropMode.INSERT is recommended, however,
for an improved user experience. It offers similar behavior of dropping
between text locations, but does so without affecting the actual text
selection and caret location.
JTextComponents support the following drop modes:
DropMode.USE_SELECTIONDropMode.INSERT
The drop mode is only meaningful if this component has a
TransferHandler that accepts drops. |
public void setEditable(boolean b) {
if (b != editable) {
boolean oldVal = editable;
editable = b;
enableInputMethods(editable);
firePropertyChange("editable", Boolean.valueOf(oldVal), Boolean.valueOf(editable));
repaint();
}
} Sets the specified boolean to indicate whether or not this
TextComponent should be editable.
A PropertyChange event ("editable") is fired when the
state is changed. |
public void setFocusAccelerator(char aKey) {
aKey = Character.toUpperCase(aKey);
char old = focusAccelerator;
focusAccelerator = aKey;
// Fix for 4341002: value of FOCUS_ACCELERATOR_KEY is wrong.
// So we fire both FOCUS_ACCELERATOR_KEY, for compatibility,
// and the correct event here.
firePropertyChange(FOCUS_ACCELERATOR_KEY, old, focusAccelerator);
firePropertyChange("focusAccelerator", old, focusAccelerator);
} Sets the key accelerator that will cause the receiving text
component to get the focus. The accelerator will be the
key combination of the alt key and the character
given (converted to upper case). By default, there is no focus
accelerator key. Any previous key accelerator setting will be
superseded. A '\0' key setting will be registered, and has the
effect of turning off the focus accelerator. When the new key
is set, a PropertyChange event (FOCUS_ACCELERATOR_KEY) will be fired. |
public void setHighlighter(Highlighter h) {
if (highlighter != null) {
highlighter.deinstall(this);
}
Highlighter old = highlighter;
highlighter = h;
if (highlighter != null) {
highlighter.install(this);
}
firePropertyChange("highlighter", old, h);
} Sets the highlighter to be used. By default this will be set
by the UI that gets installed. This can be changed to
a custom highlighter if desired. The highlighter can be set to
null to disable it.
A PropertyChange event ("highlighter") is fired
when a new highlighter is installed. |
public void setKeymap(Keymap map) {
Keymap old = keymap;
keymap = map;
firePropertyChange("keymap", old, keymap);
updateInputMap(old, map);
} Sets the keymap to use for binding events to
actions. Setting to null effectively disables
keyboard input.
A PropertyChange event ("keymap") is fired when a new keymap
is installed. |
public void setMargin(Insets m) {
Insets old = margin;
margin = m;
firePropertyChange("margin", old, m);
invalidate();
} Sets margin space between the text component's border
and its text. The text component's default Border
object will use this value to create the proper margin.
However, if a non-default border is set on the text component,
it is that Border object's responsibility to create the
appropriate margin space (else this property will effectively
be ignored). This causes a redraw of the component.
A PropertyChange event ("margin") is sent to all listeners. |
public void setNavigationFilter(NavigationFilter filter) {
navigationFilter = filter;
} Sets the NavigationFilter. NavigationFilter
is used by DefaultCaret and the default cursor movement
actions as a way to restrict the cursor movement. |
public void setSelectedTextColor(Color c) {
Color old = selectedTextColor;
selectedTextColor = c;
firePropertyChange("selectedTextColor", old, selectedTextColor);
} Sets the current color used to render the selected text.
Setting the color to null is the same as
Color.black. Setting the color results in a
PropertyChange event ("selectedTextColor") being fired. |
public void setSelectionColor(Color c) {
Color old = selectionColor;
selectionColor = c;
firePropertyChange("selectionColor", old, selectionColor);
} Sets the current color used to render the selection.
Setting the color to null is the same as setting
Color.white. Setting the color results in a
PropertyChange event ("selectionColor"). |
public void setSelectionEnd(int selectionEnd) {
/* Route through select method to enforce consistent policy
* between selectionStart and selectionEnd.
*/
select(getSelectionStart(), selectionEnd);
} Sets the selection end to the specified position. The new
end point is constrained to be at or after the current
selection start.
This is available for backward compatibility to code
that called this method on java.awt.TextComponent.
This is implemented to forward to the Caret
implementation which is where the actual selection is maintained. |
public void setSelectionStart(int selectionStart) {
/* Route through select method to enforce consistent policy
* between selectionStart and selectionEnd.
*/
select(selectionStart, getSelectionEnd());
} Sets the selection start to the specified position. The new
starting point is constrained to be before or at the current
selection end.
This is available for backward compatibility to code
that called this method on java.awt.TextComponent.
This is implemented to forward to the Caret
implementation which is where the actual selection is maintained. |
public void setText(String t) {
try {
Document doc = getDocument();
if (doc instanceof AbstractDocument) {
((AbstractDocument)doc).replace(0, doc.getLength(), t,null);
}
else {
doc.remove(0, doc.getLength());
doc.insertString(0, t, null);
}
} catch (BadLocationException e) {
UIManager.getLookAndFeel().provideErrorFeedback(JTextComponent.this);
}
} Sets the text of this TextComponent
to the specified text. If the text is null
or empty, has the effect of simply deleting the old text.
When text has been inserted, the resulting caret location
is determined by the implementation of the caret class.
Note that text is not a bound property, so no PropertyChangeEvent
is fired when it changes. To listen for changes to the text,
use DocumentListener. |
public void setUI(TextUI ui) {
super.setUI(ui);
} Sets the user-interface factory for this text-oriented editor. |
void updateInputMap(Keymap oldKm,
Keymap newKm) {
// Locate the current KeymapWrapper.
InputMap km = getInputMap(JComponent.WHEN_FOCUSED);
InputMap last = km;
while (km != null && !(km instanceof KeymapWrapper)) {
last = km;
km = km.getParent();
}
if (km != null) {
// Found it, tweak the InputMap that points to it, as well
// as anything it points to.
if (newKm == null) {
if (last != km) {
last.setParent(km.getParent());
}
else {
last.setParent(null);
}
}
else {
InputMap newKM = new KeymapWrapper(newKm);
last.setParent(newKM);
if (last != km) {
newKM.setParent(km.getParent());
}
}
}
else if (newKm != null) {
km = getInputMap(JComponent.WHEN_FOCUSED);
if (km != null) {
// Couldn't find it.
// Set the parent of WHEN_FOCUSED InputMap to be the new one.
InputMap newKM = new KeymapWrapper(newKm);
newKM.setParent(km.getParent());
km.setParent(newKM);
}
}
// Do the same thing with the ActionMap
ActionMap am = getActionMap();
ActionMap lastAM = am;
while (am != null && !(am instanceof KeymapActionMap)) {
lastAM = am;
am = am.getParent();
}
if (am != null) {
// Found it, tweak the Actionap that points to it, as well
// as anything it points to.
if (newKm == null) {
if (lastAM != am) {
lastAM.setParent(am.getParent());
}
else {
lastAM.setParent(null);
}
}
else {
ActionMap newAM = new KeymapActionMap(newKm);
lastAM.setParent(newAM);
if (lastAM != am) {
newAM.setParent(am.getParent());
}
}
}
else if (newKm != null) {
am = getActionMap();
if (am != null) {
// Couldn't find it.
// Set the parent of ActionMap to be the new one.
ActionMap newAM = new KeymapActionMap(newKm);
newAM.setParent(am.getParent());
am.setParent(newAM);
}
}
} Updates the InputMaps in response to a
Keymap change. |
public void updateUI() {
setUI((TextUI)UIManager.getUI(this));
invalidate();
} Reloads the pluggable UI. The key used to fetch the
new interface is getUIClassID(). The type of
the UI is TextUI. invalidate
is called after setting the UI. |
public int viewToModel(Point pt) {
return getUI().viewToModel(this, pt);
} Converts the given place in the view coordinate system
to the nearest representative location in the model.
The component must have a positive size for
this translation to be computed (i.e. layout cannot
be computed until the component has been sized). The
component does not have to be visible or painted. |
public void write(Writer out) throws IOException {
Document doc = getDocument();
try {
getUI().getEditorKit(this).write(out, doc, 0, doc.getLength());
} catch (BadLocationException e) {
throw new IOException(e.getMessage());
}
} Stores the contents of the model into the given
stream. By default this will store the model as plain
text. |
java.awt.Component
