|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjavax.swing.text.Utilities
public class Utilities
A set of utilities to deal with text. This is used by several other classes inside this package.
| Constructor Summary | |
|---|---|
Utilities()
Creates a new Utilities object. |
|
| Method Summary | |
|---|---|
static int |
drawTabbedText(Segment s,
int x,
int y,
Graphics g,
TabExpander e,
int startOffset)
Draws the given text segment. |
static int |
getBreakLocation(Segment s,
FontMetrics metrics,
int x0,
int x,
TabExpander e,
int startOffset)
Determine where to break the text in the given Segment, attempting to find a word boundary. |
static int |
getNextWord(JTextComponent c,
int offs)
Finds the start of the next word for the given offset. |
static Element |
getParagraphElement(JTextComponent c,
int offset)
Returns the paragraph element in the text component c at
the specified location offset. |
static int |
getPositionAbove(JTextComponent c,
int offset,
int x)
Returns the document position that is closest above to the specified x coordinate in the row containing offset. |
static int |
getPositionBelow(JTextComponent c,
int offset,
int x)
Returns the document position that is closest below to the specified x coordinate in the row containing offset. |
static int |
getPreviousWord(JTextComponent c,
int offs)
Finds the start of the previous word for the given offset. |
static int |
getRowEnd(JTextComponent c,
int offs)
Get the model position of the end of the row that contains the specified model position. |
static int |
getRowStart(JTextComponent c,
int offs)
Get the model position of the start of the row that contains the specified model position. |
static int |
getTabbedTextOffset(Segment s,
FontMetrics fm,
int x0,
int x,
TabExpander te,
int p0)
Provides a facility to map screen coordinates into a model location. |
static int |
getTabbedTextOffset(Segment s,
FontMetrics fm,
int x0,
int x,
TabExpander te,
int p0,
boolean round)
Provides a facility to map screen coordinates into a model location. |
static int |
getTabbedTextWidth(Segment s,
FontMetrics metrics,
int x,
TabExpander e,
int startOffset)
Determines the width, that the given text s would take
if it was printed with the given FontMetrics on the
specified screen position. |
static int |
getWordEnd(JTextComponent c,
int offs)
Finds the end of a word for the given location. |
static int |
getWordStart(JTextComponent c,
int offs)
Finds the start of a word for the given location. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public Utilities()
Utilities object.
| Method Detail |
|---|
public static final int drawTabbedText(Segment s,
int x,
int y,
Graphics g,
TabExpander e,
int startOffset)
TabExpander.
The X and Y coordinates denote the start of the baseline where
the text should be drawn.
s - the text fragment to be drawn.x - the x position for drawing.y - the y position for drawing.g - the Graphics context for drawing.e - the TabExpander which specifies the Tab-expanding
technique.startOffset - starting offset in the text.
public static final int getTabbedTextWidth(Segment s,
FontMetrics metrics,
int x,
TabExpander e,
int startOffset)
s would take
if it was printed with the given FontMetrics on the
specified screen position.
s - the text fragmentmetrics - the font metrics of the font to be usedx - the x coordinate of the point at which drawing should be donee - the TabExpander to be usedstartOffset - the index in s where to start
public static final int getTabbedTextOffset(Segment s,
FontMetrics fm,
int x0,
int x,
TabExpander te,
int p0,
boolean round)
[x0, x].
The parameter round controls which model location is returned
if the view coordinates are on a character: If round is
true, then the result is rounded up to the next character, so
that the resulting fragment is the smallest fragment that is larger than
the specified span. If round is false, then the
resulting fragment is the largest fragment that is smaller than the
specified span.
s - the text segmentfm - the font metrics to usex0 - the starting screen locationx - the target screen location at which the requested fragment should
endte - the tab expander to use; if this is null, TABs are
expanded to one space characterp0 - the starting model locationround - if true round up to the next location, otherwise
round down to the current location
public static final int getTabbedTextOffset(Segment s,
FontMetrics fm,
int x0,
int x,
TabExpander te,
int p0)
[x0, x].
This method rounds up to the next location, so that the resulting fragment
will be the smallest fragment of the text, that is greater than the
specified span.
s - the text segmentfm - the font metrics to usex0 - the starting screen locationx - the target screen location at which the requested fragment should
endte - the tab expander to use; if this is null, TABs are
expanded to one space characterp0 - the starting model location
public static final int getNextWord(JTextComponent c,
int offs)
throws BadLocationException
c - the text componentoffs - the offset in the document
BadLocationException - if the offset is invalid.
public static final int getPreviousWord(JTextComponent c,
int offs)
throws BadLocationException
c - the text componentoffs - the offset in the document
BadLocationException - if the offset is invalid.
public static final int getWordStart(JTextComponent c,
int offs)
throws BadLocationException
c - the text componentoffs - the offset location
BadLocationException - if the offset location is invalid
public static final int getWordEnd(JTextComponent c,
int offs)
throws BadLocationException
c - the text componentoffs - the offset location
BadLocationException - if the offset location is invalid
public static final int getRowEnd(JTextComponent c,
int offs)
throws BadLocationException
c - the JTextComponentoffs - the model position
BadLocationException - if the offset is invalid
public static final int getRowStart(JTextComponent c,
int offs)
throws BadLocationException
c - the JTextComponentoffs - the model position
BadLocationException - if the offset is invalid
public static final int getBreakLocation(Segment s,
FontMetrics metrics,
int x0,
int x,
TabExpander e,
int startOffset)
s - the Segment that holds the textmetrics - the font metrics used for calculating the break pointx0 - starting view location representing the start of the textx - the target view locatione - the TabExpander used for expanding tabs (if this is null tabs
are expanded to 1 space)startOffset - the offset in the Document of the start of the text
public static final Element getParagraphElement(JTextComponent c,
int offset)
c at
the specified location offset.
c - the text componentoffset - the offset of the paragraph element to return
offset
public static final int getPositionAbove(JTextComponent c,
int offset,
int x)
throws BadLocationException
offset.
c - the text componentoffset - the offsetx - the x coordinate
offset
BadLocationException - if offset is not a valid offset
public static final int getPositionBelow(JTextComponent c,
int offset,
int x)
throws BadLocationException
offset.
c - the text componentoffset - the offsetx - the x coordinate
offset
BadLocationException - if offset is not a valid offset
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||