FileDocCategorySizeDatePackage
TextUI.javaAPI DocJava SE 5 API5250Fri Aug 26 14:58:02 BST 2005javax.swing.plaf

TextUI

public abstract class TextUI extends ComponentUI
Text editor user interface
author
Timothy Prinzing
version
1.32 12/19/03

Fields Summary
Constructors Summary
Methods Summary
public abstract voiddamageRange(javax.swing.text.JTextComponent t, int p0, int p1)
Causes the portion of the view responsible for the given part of the model to be repainted.

param
p0 the beginning of the range >= 0
param
p1 the end of the range >= p0

public abstract voiddamageRange(javax.swing.text.JTextComponent t, int p0, int p1, javax.swing.text.Position$Bias firstBias, javax.swing.text.Position$Bias secondBias)
Causes the portion of the view responsible for the given part of the model to be repainted.

param
p0 the beginning of the range >= 0
param
p1 the end of the range >= p0

public abstract javax.swing.text.EditorKitgetEditorKit(javax.swing.text.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.

return
the editor kit binding

public abstract intgetNextVisualPositionFrom(javax.swing.text.JTextComponent t, int pos, javax.swing.text.Position$Bias b, int direction, javax.swing.text.Position$Bias[] biasRet)
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.

param
pos the position to convert >= 0
param
a the allocated region to render into
param
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.
return
the location within the model that best represents the next location visual position.
exception
BadLocationException
exception
IllegalArgumentException for an invalid direction

public abstract javax.swing.text.ViewgetRootView(javax.swing.text.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.

return
the view

public java.lang.StringgetToolTipText(javax.swing.text.JTextComponent t, java.awt.Point pt)
Returns the string to be used as the tooltip at the passed in location.

see
javax.swing.text.JTextComponent#getToolTipText
since
1.4

        return null;
    
public abstract java.awt.RectanglemodelToView(javax.swing.text.JTextComponent t, int pos)
Converts the given location in the model to a place in the view coordinate system.

param
pos the local location in the model to translate >= 0
return
the coordinates as a rectangle
exception
BadLocationException if the given position does not represent a valid location in the associated document

public abstract java.awt.RectanglemodelToView(javax.swing.text.JTextComponent t, int pos, javax.swing.text.Position$Bias bias)
Converts the given location in the model to a place in the view coordinate system.

param
pos the local location in the model to translate >= 0
return
the coordinates as a rectangle
exception
BadLocationException if the given position does not represent a valid location in the associated document

public abstract intviewToModel(javax.swing.text.JTextComponent t, java.awt.Point pt)
Converts the given place in the view coordinate system to the nearest representative location in the model.

param
pt the location in the view to translate. This should be in the same coordinate system as the mouse events.
return
the offset from the start of the document >= 0

public abstract intviewToModel(javax.swing.text.JTextComponent t, java.awt.Point pt, javax.swing.text.Position$Bias[] biasReturn)
Provides a mapping from the view coordinate space to the logical coordinate space of the model.

param
pt the location in the view to translate. This should be in the same coordinate system as the mouse events.
param
biasReturn filled in by this method to indicate whether the point given is closer to the previous or the next character in the model
return
the location within the model that best represents the given point in the view >= 0