Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans^TM has been added to the java.beans package. Please see {@link java.beans.XMLEncoder}. 

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans^TM has been added to the java.beans package. Please see {@link java.beans.XMLEncoder}. 

KeymapActionMap is then able to transate the object passed in to either message the Keymap, or message its default implementation. 

 public JTextComponent() 
{
        super();
        // enable InputMethodEvent for on-the-spot pre-editing
        enableEvents(AWTEvent.KEY_EVENT_MASK | AWTEvent.INPUT_METHOD_EVENT_MASK);
        caretEvent = new MutableCaretEvent(this);
        addMouseListener(caretEvent);
        addFocusListener(caretEvent);
        setEditable(true);
        setDragEnabled(false);
        setLayout(null); // layout is managed by View hierarchy
        updateUI();
}

Creates a new JTextComponent. Listeners for caret events are established, and the pluggable UI installed. The component is marked as editable. No layout manager is used, because layout is managed by the view subsystem of text. The document model is set to null.

 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.

 JTextComponent.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 (CaretListener[])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 JTextComponent.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 =
                (InputMethodRequests)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() 
{
        if (getParent() instanceof JViewport) {
            return (((JViewport)getParent()).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() 
{
        if (getParent() instanceof JViewport) {
            return (((JViewport)getParent()).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:
1. If setToolTipText has been invoked with a non-null value, it will be returned, otherwise
2. 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,
    JTextComponent.KeyBinding[] bindings,
    Action[] actions) 
{
        Hashtable h = new Hashtable();
        for (int i = 0; i <  actions.length; i++) {
            Action a = actions[i];
            String value = (String)a.getValue(Action.NAME);
            h.put((value!=null ? value:""), a);
        }
        for (int i = 0; i <  bindings.length; i++) {
            Action a = (Action) h.get(bindings[i].actionName);
            if (a != null) {
                map.addActionForKeyStroke(bindings[i].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;
}

Returns a string representation of this JTextComponent. This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations. The returned string may be empty but may not be null.

Overriding paramString to provide information about the specific new aspects of the JFC components.

 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);
                            }
                        }
                    }
                }