Package Summary  Overview Summary

class:TextUI [NONE]

constructor:TextUI() [NONE]

  • TextUI

    public TextUI​()

method:modelToView(javax.swing.text.JTextComponent, int) [NONE]

method:modelToView(javax.swing.text.JTextComponent, int, javax.swing.text.Position.Bias) [NONE]

method:modelToView2D(javax.swing.text.JTextComponent, int, javax.swing.text.Position.Bias) [NONE]

  • modelToView2D

    public Rectangle2D modelToView2D​(JTextComponent t,
                                 int pos,
                                 Position.Bias bias)
                          throws BadLocationException
    Converts the given location in the model to a place in the view coordinate system.
    Implementation Requirements:
    This implementation calls modelToView(t, pos, bias) .
    Parameters:
    t - the text component for which this UI is installed
    pos - the local location in the model to translate >= 0
    bias - the bias for the position
    Returns:
    the coordinates as a Rectangle2D
    Throws:
    BadLocationException - if the given position does not represent a valid location in the associated document
    Since:
    9

method:viewToModel(javax.swing.text.JTextComponent, java.awt.Point) [NONE]

  • viewToModel

    @Deprecated(since="9")
public abstract int viewToModel​(JTextComponent t,
                                Point pt)
    Deprecated. replaced by viewToModel2D(JTextComponent, Point2D, Position.Bias[])
    Converts the given place in the view coordinate system to the nearest representative location in the model.
    Parameters:
    t - the text component for which this UI is installed
    pt - the location in the view to translate. This should be in the same coordinate system as the mouse events.
    Returns:
    the offset from the start of the document >= 0

method:viewToModel(javax.swing.text.JTextComponent, java.awt.Point, javax.swing.text.Position.Bias[]) [NONE]

  • viewToModel

    @Deprecated(since="9")
public abstract int viewToModel​(JTextComponent t,
                                Point pt,
                                Position.Bias[] biasReturn)
    Deprecated. replaced by viewToModel2D(JTextComponent, Point2D, Position.Bias[])
    Provides a mapping from the view coordinate space to the logical coordinate space of the model.
    Parameters:
    t - the text component for which this UI is installed
    pt - the location in the view to translate. This should be in the same coordinate system as the mouse events.
    biasReturn - filled in by this method to indicate whether the point given is closer to the previous or the next character in the model
    Returns:
    the location within the model that best represents the given point in the view >= 0

method:viewToModel2D(javax.swing.text.JTextComponent, java.awt.geom.Point2D, javax.swing.text.Position.Bias[]) [NONE]

  • viewToModel2D

    public int viewToModel2D​(JTextComponent t,
                         Point2D pt,
                         Position.Bias[] biasReturn)
    Provides a mapping from the view coordinate space to the logical coordinate space of the model.
    Implementation Requirements:
    This implementation calls viewToModel(t, new Point((int) pt.getX(), (int) pt.getY()), biasReturn) .
    Parameters:
    t - the text component for which this UI is installed
    pt - the location in the view to translate.
    biasReturn - filled in by this method to indicate whether the point given is closer to the previous or the next character in the model
    Returns:
    the location within the model that best represents the given point in the view >= 0
    Since:
    9

method:getNextVisualPositionFrom(javax.swing.text.JTextComponent, int, javax.swing.text.Position.Bias, int, javax.swing.text.Position.Bias[]) [NONE]

  • getNextVisualPositionFrom

    public abstract int getNextVisualPositionFrom​(JTextComponent t,
                                              int pos,
                                              Position.Bias b,
                                              int direction,
                                              Position.Bias[] biasRet)
                                       throws BadLocationException
    Provides a way to determine the next visually represented model location that one might place a caret. Some views may not be visible, they might not be in the same order found in the model, or they just might not allow access to some of the locations in the model.
    Parameters:
    t - the text component for which this UI is installed
    pos - the position to convert >= 0
    b - the bias for the position
    direction - the direction from the current position that can be thought of as the arrow keys typically found on a keyboard. This may be SwingConstants.WEST, SwingConstants.EAST, SwingConstants.NORTH, or SwingConstants.SOUTH
    biasRet - an array to contain the bias for the returned position
    Returns:
    the location within the model that best represents the next location visual position
    Throws:
    BadLocationException - for a bad location within a document model
    IllegalArgumentException - for an invalid direction

method:damageRange(javax.swing.text.JTextComponent, int, int) [NONE]

  • damageRange

    public abstract void damageRange​(JTextComponent t,
                                 int p0,
                                 int p1)
    Causes the portion of the view responsible for the given part of the model to be repainted.
    Parameters:
    t - the text component for which this UI is installed
    p0 - the beginning of the range >= 0
    p1 - the end of the range >= p0

method:damageRange(javax.swing.text.JTextComponent, int, int, javax.swing.text.Position.Bias, javax.swing.text.Position.Bias) [NONE]

  • damageRange

    public abstract void damageRange​(JTextComponent t,
                                 int p0,
                                 int p1,
                                 Position.Bias firstBias,
                                 Position.Bias secondBias)
    Causes the portion of the view responsible for the given part of the model to be repainted.
    Parameters:
    t - the text component for which this UI is installed
    p0 - the beginning of the range >= 0
    p1 - the end of the range >= p0
    firstBias - the bias of the first character position, toward the previous character or the next character
    secondBias - the bias of the second character position, toward the previous character or the next character

method:getEditorKit(javax.swing.text.JTextComponent) [NONE]

  • getEditorKit

    public abstract EditorKit getEditorKit​(JTextComponent t)
    Fetches the binding of services that set a policy for the type of document being edited. This contains things like the commands available, stream readers and writers, etc.
    Parameters:
    t - the text component for which this UI is installed
    Returns:
    the editor kit binding

method:getRootView(javax.swing.text.JTextComponent) [NONE]

  • getRootView

    public abstract View getRootView​(JTextComponent t)
    Fetches a View with the allocation of the associated text component (i.e. the root of the hierarchy) that can be traversed to determine how the model is being represented spatially.
    Parameters:
    t - the text component for which this UI is installed
    Returns:
    a View with the allocation of the associated text component

method:getToolTipText(javax.swing.text.JTextComponent, java.awt.Point) [NONE]

method:getToolTipText2D(javax.swing.text.JTextComponent, java.awt.geom.Point2D) [NONE]