package org.eclipse.swt.custom; | |
/* | |
* (c) Copyright IBM Corp. 2000, 2001. | |
* All Rights Reserved | |
*/ | |
import org.eclipse.swt.*; | |
import org.eclipse.swt.dnd.*; | |
import org.eclipse.swt.events.*; | |
import org.eclipse.swt.graphics.*; | |
import org.eclipse.swt.widgets.*; | |
import java.util.*; | |
/** | |
* A StyledText is an editable user interface object that displays lines | |
* of text. The following style attributes can be defined for the text: | |
* <ul> | |
* <li>foreground color | |
* <li>background color | |
* <li>font style (bold, regular) | |
* </ul> | |
* <p> | |
* In addition to text style attributes, the background color of a line may | |
* be specified. | |
* </p> | |
* <p> | |
* There are two ways to use this widget when specifying text style information. | |
* You may use the API that is defined for StyledText or you may define your own | |
* LineStyleListener. If you define your own listener, you will be responsible | |
* for maintaining the text style information for the widget. IMPORTANT: You may | |
* not define your own listener and use the StyledText API. The following | |
* StyledText API is not supported if you have defined a LineStyleListener: | |
* <ul> | |
* <li>getStyleRangeAtOffset(int) | |
* <li>getStyleRanges() | |
* <li>setStyleRange(StyleRange) | |
* <li>setStyleRanges(StyleRange[]) | |
* </ul> | |
* </p> | |
* <p> | |
* There are two ways to use this widget when specifying line background colors. | |
* You may use the API that is defined for StyledText or you may define your own | |
* LineBackgroundListener. If you define your own listener, you will be responsible | |
* for maintaining the line background color information for the widget. | |
* IMPORTANT: You may not define your own listener and use the StyledText API. | |
* The following StyledText API is not supported if you have defined a | |
* LineBackgroundListener: | |
* <ul> | |
* <li>getLineBackground(int) | |
* <li>setLineBackground(int,int,Color) | |
* </ul> | |
* </p> | |
* <p> | |
* The content implementation for this widget may also be user-defined. To do so, | |
* you must implement the StyledTextContent interface and use the StyledText API | |
* setContent(StyledTextContent) to initialize the widget. | |
* </p> | |
* <p> | |
* IMPORTANT: This class is <em>not</em> intended to be subclassed. | |
* </p> | |
* <dl> | |
* <dt><b>Styles:</b><dd>FULL_SELECTION, MULTI, SINGLE, READ_ONLY | |
* <dt><b>Events:</b><dd>ExtendedModify, LineGetBackground, LineGetStyle, Modify, Selection, Verify, VerifyKey | |
* </dl> | |
*/ | |
public class StyledText extends Canvas { | |
static final int CARET_WIDTH = 1; // width of the caret. Used during content width calculation since | |
// Caret.getSize() does not return its width until it is made visible. | |
static final char TAB = '\t'; | |
private final static String PlatformLineDelimiter = System.getProperty("line.separator"); | |
StyledTextContent content; | |
TextChangeListener textChangeListener; // listener for TextChanging, TextChanged and TextSet events from StyledTextContent | |
DefaultLineStyler defaultLineStyler;// used for setStyles API when no LineStyleListener is registered | |
boolean userLineStyle = false; // true=widget is using a user defined line style listener for line styles. false=widget is using the default line styler to store line styles | |
boolean userLineBackground = false;// true=widget is using a user defined line background listener for line backgrounds. false=widget is using the default line styler to store line backgrounds | |
int verticalScrollOffset = 0; // pixel based | |
int horizontalScrollOffset = 0; // pixel based | |
int topIndex = 0; // top visible line | |
int clientAreaHeight = 0; // the client area height. Needed to calculate content width for new | |
// visible lines during Resize callback | |
int contentWidth = 0; // width of widest known (already visible) line | |
int contentWidthIndex = 0; // line up to which the content width has been calculated | |
int lineHeight; // line height=font height | |
int tabLength = 4; // number of characters in a tab | |
int tabWidth; // width of a tab character in the current GC | |
Caret caret; // caret SWT widget | |
Cursor ibeamCursor; | |
int caretOffset = 0; | |
Point selection = new Point(0, 0); // x is character offset, y is length | |
int selectionAnchor; // position of selection anchor. 0 based offset from beginning of text | |
boolean editable = true; | |
boolean doubleClickEnabled = true; // see getDoubleClickEnabled | |
boolean overwrite = false; // insert/overwrite edit mode | |
int textLimit = -1; // limits the number of characters the user can type in the widget. Unlimited by default. | |
boolean selectionVisible = true; | |
Hashtable keyActionMap = new Hashtable(); | |
Font boldFont; | |
Font regularFont; | |
Clipboard clipboard; | |
boolean mouseDoubleClick = false; // true=a double click ocurred. Don't do mouse swipe selection. | |
int autoScrollDirection = SWT.NULL; // the direction of autoscrolling (up, down, right, left) | |
int lastTextChangeStart; // cache data of the | |
int lastTextChangeNewLineCount; // last text changing | |
int lastTextChangeNewCharCount; // event for use in the | |
int lastTextChangeReplaceCharCount; // text changed handler | |
static final int DEFAULT_WIDTH = 64; | |
static final int DEFAULT_HEIGHT = 64; | |
static final int ExtendedModify = 3000; | |
static final int LineGetBackground = 3001; | |
static final int LineGetStyle = 3002; | |
static final int TextChanging = 3003; | |
static final int TextChanged = 3006; | |
static final int TextSet = 3004; | |
static final int VerifyKey = 3005; | |
/** | |
* The <code>RTFWriter</code> class is used to write widget content as | |
* rich text. The implementation complies with the RTF specification | |
* version 1.5. | |
* <p> | |
* toString() is guaranteed to return a valid RTF string only after | |
* close() has been called. | |
* </p> | |
* <p> | |
* Whole and partial lines and line breaks can be written. Lines will be | |
* formatted using the styles queried from the LineStyleListener, if | |
* set, or those set directly in the widget. All styles are applied to | |
* the RTF stream like they are rendered by the widget. In addition, the | |
* widget font name and size is used for the whole text. | |
* </p> | |
*/ | |
class RTFWriter extends TextWriter { | |
final int DEFAULT_FOREGROUND = 0; | |
final int DEFAULT_BACKGROUND = 1; | |
Vector colorTable = new Vector(); | |
/** | |
* Creates a RTF writer that writes content starting at offset "start" | |
* in the document. <code>start</code> and <code>length</code>can be set to specify partial | |
* lines. | |
* <p> | |
* | |
* @param start start offset of content to write, 0 based from | |
* beginning of document | |
* @param length length of content to write | |
*/ | |
public RTFWriter(int start, int length) { | |
super(start, length); | |
colorTable.addElement(getForeground()); | |
colorTable.addElement(getBackground()); | |
} | |
/** | |
* Closes the RTF writer. Once closed no more content can be written. | |
* <b>NOTE:</b> <code>toString()</code> does not return a valid RTF string until | |
* <code>close()</code> has been called. | |
*/ | |
public void close() { | |
if (isClosed() == false) { | |
writeHeader(); | |
write("\n}}\0"); | |
super.close(); | |
} | |
} | |
/** | |
* Returns the index of the specified color in the RTF color table. | |
* <p> | |
* | |
* @param color the color | |
* @param defaultIndex return value if color is null | |
* @return the index of the specified color in the RTF color table | |
* or "defaultIndex" if "color" is null. | |
*/ | |
int getColorIndex(Color color, int defaultIndex) { | |
int index; | |
if (color == null) { | |
index = defaultIndex; | |
} | |
else { | |
index = colorTable.indexOf(color); | |
if (index == -1) { | |
index = colorTable.size(); | |
colorTable.addElement(color); | |
} | |
} | |
return index; | |
} | |
/** | |
* Writes the RTF header including font table and color table. | |
*/ | |
void writeHeader() { | |
StringBuffer header = new StringBuffer(); | |
FontData fontData = getFont().getFontData()[0]; | |
header.append("{\\rtf1\\ansi\\deff0{\\fonttbl{\\f0\\fnil "); | |
header.append(fontData.getName()); | |
header.append(";}}\n{\\colortbl"); | |
for (int i = 0; i < colorTable.size(); i++) { | |
Color color = (Color) colorTable.elementAt(i); | |
header.append("\\red"); | |
header.append(color.getRed()); | |
header.append("\\green"); | |
header.append(color.getGreen()); | |
header.append("\\blue"); | |
header.append(color.getBlue()); | |
header.append(";"); | |
} | |
// some RTF readers ignore the deff0 font tag. Explicitly | |
// set the font for the whole document to work around this. | |
header.append("}\n{\\f0\\fs"); | |
// font size is specified in half points | |
header.append(fontData.getHeight() * 2); | |
header.append(" "); | |
write(header.toString(), 0); | |
} | |
/** | |
* Appends the specified line text to the RTF data. Lines will be formatted | |
* using the styles queried from the LineStyleListener, if set, or those set | |
* directly in the widget. | |
* <p> | |
* | |
* @param line line text to write as RTF. Must not contain line breaks | |
* Line breaks should be written using writeLineDelimiter() | |
* @param lineOffset offset of the line. 0 based from the start of the | |
* widget document. Any text occurring before the start offset or after the | |
* end offset specified during object creation is ignored. | |
* @exception SWTException <ul> | |
* <li>ERROR_IO when the writer is closed.</li> | |
* </ul> | |
*/ | |
public void writeLine(String line, int lineOffset) { | |
StyleRange[] styles = new StyleRange[0]; | |
Color lineBackground = null; | |
StyledTextEvent event; | |
if (isClosed()) { | |
SWT.error(SWT.ERROR_IO); | |
} | |
event = getLineStyleData(lineOffset, line); | |
if (event != null) { | |
styles = event.styles; | |
} | |
event = getLineBackgroundData(lineOffset, line); | |
if (event != null) { | |
lineBackground = event.lineBackground; | |
} | |
if (lineBackground == null) { | |
lineBackground = getBackground(); | |
} | |
writeStyledLine(line, lineOffset, styles, lineBackground); | |
} | |
/** | |
* Appends the specified line delmimiter to the RTF data. | |
* <p> | |
* | |
* @param lineDelimiter line delimiter to write as RTF. | |
* @exception SWTException <ul> | |
* <li>ERROR_IO when the writer is closed.</li> | |
* </ul> | |
*/ | |
public void writeLineDelimiter(String lineDelimiter) { | |
if (isClosed()) { | |
SWT.error(SWT.ERROR_IO); | |
} | |
write(lineDelimiter, 0, lineDelimiter.length()); | |
write("\\par "); | |
} | |
/** | |
* Appends the specified segment of "string" to the RTF data. | |
* Copy from <code>start</code> up to, but excluding, <code>end</code>. | |
* <p> | |
* | |
* @param string string to copy a segment from. Must not contain | |
* line breaks. Line breaks should be written using writeLineDelimiter() | |
* @param start start offset of segment. 0 based. | |
* @param end end offset of segment | |
*/ | |
void write(String string, int start, int end) { | |
int index; | |
for (index = start; index < end; index++) { | |
char c = string.charAt(index); | |
if (c == '}' || c == '{' || c == '\\') { | |
break; | |
} | |
} | |
if (index == end) { | |
write(string.substring(start, end)); // string doesn't contain RTF formatting characters, write as is | |
} | |
else { // string needs to be transformed | |
char[] text = new char[end - start]; | |
string.getChars(start, end, text, 0); | |
for (index = 0; index < text.length; index++) { | |
switch (text[index]) { | |
case '}': | |
case '{': | |
case '\\': | |
write("\\"); | |
default: | |
write(text[index]); | |
} | |
} | |
} | |
} | |
/** | |
* Appends the specified line text to the RTF data. | |
* Use the colors and font styles specified in "styles" and "lineBackground". | |
* Formatting is written to reflect the text rendering by the text widget. | |
* Style background colors take precedence over the line background color. | |
* Background colors are written using the \highlight tag (vs. the \cb tag). | |
* <p> | |
* | |
* @param line line text to write as RTF. Must not contain line breaks | |
* Line breaks should be written using writeLineDelimiter() | |
* @param lineOffset offset of the line. 0 based from the start of the | |
* widget document. Any text occurring before the start offset or after the | |
* end offset specified during object creation is ignored. | |
* @param styles styles to use for formatting. Must not be null. | |
* @param linebackground line background color to use for formatting. | |
* May be null. | |
*/ | |
void writeStyledLine(String line, int lineOffset, StyleRange[] styles, Color lineBackground) { | |
int lineLength = line.length(); | |
int lineIndex; | |
int copyEnd; | |
int startOffset = getStart(); | |
int endOffset = startOffset + super.getCharCount(); | |
int writeOffset = startOffset - lineOffset; | |
if (writeOffset >= line.length()) { | |
return; // whole line is outside write range | |
} | |
else | |
if (writeOffset > 0) { | |
lineIndex = writeOffset; // line starts before RTF write start | |
} | |
else { | |
lineIndex = 0; | |
} | |
if (lineBackground != null) { | |
write("{\\highlight"); | |
write(getColorIndex(lineBackground, DEFAULT_BACKGROUND)); | |
write(" "); | |
} | |
for (int i = 0; i < styles.length; i++) { | |
StyleRange style = styles[i]; | |
int start = style.start - lineOffset; | |
int end = start + style.length; | |
int colorIndex; | |
// skip over partial first line | |
if (end < writeOffset) { | |
continue; | |
} | |
// break on partial last line | |
if (style.start > endOffset) { | |
break; | |
} | |
// write any unstyled text | |
if (lineIndex < start) { | |
// copy to start of style or end of write range (specified | |
// during object creation) or end of line | |
copyEnd = Math.min(start, endOffset - lineOffset); | |
copyEnd = Math.min(copyEnd, lineLength); | |
write(line, lineIndex, copyEnd); | |
lineIndex = copyEnd; | |
if (copyEnd != start) { | |
break; | |
} | |
} | |
// write styled text | |
colorIndex = getColorIndex(style.background, DEFAULT_BACKGROUND); | |
write("{\\cf"); | |
write(getColorIndex(style.foreground, DEFAULT_FOREGROUND)); | |
if (colorIndex != DEFAULT_BACKGROUND) { | |
write("\\highlight"); | |
write(colorIndex); | |
} | |
if (style.fontStyle == SWT.BOLD) { | |
write("\\b"); | |
} | |
write(" "); | |
// copy to end of style or end of write range (specified | |
// during object creation) or end of line | |
copyEnd = Math.min(end, endOffset - lineOffset); | |
copyEnd = Math.min(copyEnd, lineLength); | |
write(line, lineIndex, copyEnd); | |
if (style.fontStyle == SWT.BOLD) { | |
write("\\b0"); | |
} | |
write("}"); | |
lineIndex = copyEnd; | |
if (copyEnd != end) { | |
break; | |
} | |
} | |
copyEnd = Math.min(lineLength, endOffset - lineOffset); | |
if (lineIndex < copyEnd) { | |
write(line, lineIndex, copyEnd); | |
} | |
if (lineBackground != null) { | |
write("}"); | |
} | |
} | |
} | |
/** | |
* The <code>TextWriter</code> class is used to write widget content to | |
* a string. Whole and partial lines and line breaks can be written. To write | |
* partial lines, specify the start and length of the desired segment | |
* during object creation. | |
* <p> | |
* </b>NOTE:</b> <code>toString()</code> is guaranteed to return a valid string only after close() | |
* has been called. | |
*/ | |
class TextWriter { | |
private StringBuffer buffer; | |
private int startOffset; // offset of first character that will be written | |
private int endOffset; // offset of last character that will be written. | |
// 0 based from the beginning of the widget text. | |
private boolean isClosed = false; | |
/** | |
* Creates a writer that writes content starting at offset "start" | |
* in the document. <code>start</code> and <code>length</code> can be set to specify partial lines. | |
* <p> | |
* | |
* @param start start offset of content to write, 0 based from beginning of document | |
* @param length length of content to write | |
*/ | |
public TextWriter(int start, int length) { | |
buffer = new StringBuffer(length); | |
startOffset = start; | |
endOffset = start + length; | |
} | |
/** | |
* Closes the writer. Once closed no more content can be written. | |
* <b>NOTE:</b> <code>toString()</code> is not guaranteed to return a valid string unless | |
* the writer is closed. | |
*/ | |
public void close() { | |
if (isClosed == false) { | |
isClosed = true; | |
} | |
} | |
/** | |
* Returns the number of characters to write. | |
*/ | |
public int getCharCount() { | |
return endOffset - startOffset; | |
} | |
/** | |
* Returns the offset where writing starts. 0 based from the start of | |
* the widget text. Used to write partial lines. | |
*/ | |
public int getStart() { | |
return startOffset; | |
} | |
/** | |
* Returns whether the writer is closed. | |
*/ | |
public boolean isClosed() { | |
return isClosed; | |
} | |
/** | |
* Returns the string. <code>close()</code> must be called before <code>toString()</code> | |
* is guaranteed to return a valid string. | |
* <p> | |
* | |
* @return the string | |
*/ | |
public String toString() { | |
return buffer.toString(); | |
} | |
/** | |
* Appends the given string to the data. | |
*/ | |
void write(String string) { | |
buffer.append(string); | |
} | |
/** | |
* Inserts the given string to the data at the specified offset. | |
* Do nothing if "offset" is < 0 or > getCharCount() | |
* <p> | |
* | |
* @param string text to insert | |
* @param offset offset in the existing data to insert "string" at. | |
*/ | |
void write(String string, int offset) { | |
if (offset < 0 || offset > buffer.length()) { | |
return; | |
} | |
buffer.insert(offset, string); | |
} | |
/** | |
* Appends the given int to the data. | |
*/ | |
void write(int i) { | |
buffer.append(i); | |
} | |
/** | |
* Appends the given character to the data. | |
*/ | |
void write(char i) { | |
buffer.append(i); | |
} | |
/** | |
* Appends the specified line text to the data. | |
* <p> | |
* | |
* @param line line text to write. Must not contain line breaks | |
* Line breaks should be written using writeLineDelimiter() | |
* @param lineOffset offset of the line. 0 based from the start of the | |
* widget document. Any text occurring before the start offset or after the | |
* end offset specified during object creation is ignored. | |
* @exception SWTException <ul> | |
* <li>ERROR_IO when the writer is closed.</li> | |
* </ul> | |
*/ | |
public void writeLine(String line, int lineOffset) { | |
int lineLength = line.length(); | |
int lineIndex; | |
int copyEnd; | |
int writeOffset = startOffset - lineOffset; | |
if (isClosed) { | |
SWT.error(SWT.ERROR_IO); | |
} | |
if (writeOffset >= lineLength) { | |
return; // whole line is outside write range | |
} | |
else | |
if (writeOffset > 0) { | |
lineIndex = writeOffset; // line starts before write start | |
} | |
else { | |
lineIndex = 0; | |
} | |
copyEnd = Math.min(lineLength, endOffset - lineOffset); | |
if (lineIndex < copyEnd) { | |
write(line.substring(lineIndex, copyEnd)); | |
} | |
} | |
/** | |
* Appends the specified line delmimiter to the data. | |
* <p> | |
* | |
* @param lineDelimiter line delimiter to write | |
* @exception SWTException <ul> | |
* <li>ERROR_IO when the writer is closed.</li> | |
* </ul> | |
*/ | |
public void writeLineDelimiter(String lineDelimiter) { | |
if (isClosed) { | |
SWT.error(SWT.ERROR_IO); | |
} | |
write(lineDelimiter); | |
} | |
} | |
public StyledText(Composite parent, int style) { | |
// use NO_BACKGROUND style when implemented by SWT. | |
// always need to draw background in drawLine when using NO_BACKGROUND! | |
super(parent, checkStyle(style | SWT.NO_REDRAW_RESIZE | SWT.NO_BACKGROUND)); | |
Display display = getDisplay(); | |
if ((style & SWT.READ_ONLY) != 0) { | |
setEditable(false); | |
} | |
clipboard = new Clipboard(display); | |
calculateLineHeight(); | |
calculateTabWidth(); | |
caret = new Caret(this, SWT.NULL); | |
caret.setBounds(0, 0, CARET_WIDTH, lineHeight); | |
installDefaultContent(); | |
calculateScrollBars(); | |
createKeyBindings(); | |
ibeamCursor = new Cursor(display, SWT.CURSOR_IBEAM); | |
setCursor(ibeamCursor); | |
setForeground(display.getSystemColor(SWT.COLOR_LIST_FOREGROUND)); | |
setBackground(display.getSystemColor(SWT.COLOR_LIST_BACKGROUND)); | |
initializeFonts(); | |
installListeners(); | |
installDefaultLineStyler(); | |
} | |
/** | |
* Adds an extended modify listener. An ExtendedModify event is sent by the | |
* widget when the widget text has changed. | |
* <p> | |
* | |
* @param listener the listener | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_NULL_ARGUMENT when listener is null</li> | |
* </ul> | |
*/ | |
public void addExtendedModifyListener(ExtendedModifyListener extendedModifyListener) { | |
checkWidget(); | |
if (extendedModifyListener == null) SWT.error(SWT.ERROR_NULL_ARGUMENT); | |
StyledTextListener typedListener = new StyledTextListener(extendedModifyListener); | |
addListener(ExtendedModify, typedListener); | |
} | |
/** | |
* Maps a key to an action. | |
* One action can be associated with N keys. However, each key can only | |
* have one action (key:action is N:1 relation). | |
* <p> | |
* | |
* @param key a key code defined in SWT.java or a character. | |
* Optionally ORd with a state mask (one or more of SWT.CTRL, SWT.SHIFT, SWT.ALT) | |
* @param action one of the predefined actions defined in ST.java. | |
* Use SWT.NULL to remove a key binding. | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public void setKeyBinding(int key, int action) { | |
checkWidget(); | |
if (action == SWT.NULL) { | |
keyActionMap.remove(new Integer(key)); | |
} | |
else { | |
keyActionMap.put(new Integer(key), new Integer(action)); | |
} | |
} | |
/** | |
* Adds a line background listener. A LineGetBackground event is sent by the | |
* widget to determine the background color for a line. | |
* <p> | |
* | |
* @param listener the listener | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_NULL_ARGUMENT when listener is null</li> | |
* </ul> | |
*/ | |
public void addLineBackgroundListener(LineBackgroundListener listener) { | |
checkWidget(); | |
if (listener == null) SWT.error(SWT.ERROR_NULL_ARGUMENT); | |
if (userLineBackground == false) { | |
removeLineBackgroundListener(defaultLineStyler); | |
defaultLineStyler.setLineBackground(0, content.getLineCount(), null); | |
userLineBackground = true; | |
} | |
StyledTextListener typedListener = new StyledTextListener(listener); | |
addListener(LineGetBackground, typedListener); | |
} | |
/** | |
* Adds a line style listener. A LineGetStyle event is sent by the widget to | |
* determine the styles for a line. | |
* <p> | |
* | |
* @param listener the listener | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_NULL_ARGUMENT when listener is null</li> | |
* </ul> | |
*/ | |
public void addLineStyleListener(LineStyleListener listener) { | |
checkWidget(); | |
if (listener == null) { | |
SWT.error(SWT.ERROR_NULL_ARGUMENT); | |
} | |
if (userLineStyle == false) { | |
removeLineStyleListener(defaultLineStyler); | |
defaultLineStyler.setStyleRange(null); | |
userLineStyle = true; | |
} | |
StyledTextListener typedListener = new StyledTextListener(listener); | |
addListener(LineGetStyle, typedListener); | |
} | |
/** | |
* Adds a modify listener. A Modify event is sent by the widget when the widget text | |
* has changed. | |
* <p> | |
* | |
* @param listener the listener | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_NULL_ARGUMENT when listener is null</li> | |
* </ul> | |
*/ | |
public void addModifyListener(ModifyListener modifyListener) { | |
checkWidget(); | |
if (modifyListener == null) { | |
SWT.error(SWT.ERROR_NULL_ARGUMENT); | |
} | |
TypedListener typedListener = new TypedListener(modifyListener); | |
addListener(SWT.Modify, typedListener); | |
} | |
/** | |
* Adds a selection listener. A Selection event is sent by the widget when the | |
* selection has changed. | |
* <p> | |
* | |
* @param listener the listener | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_NULL_ARGUMENT when listener is null</li> | |
* </ul> | |
*/ | |
public void addSelectionListener(SelectionListener listener) { | |
checkWidget(); | |
if (listener == null) { | |
SWT.error(SWT.ERROR_NULL_ARGUMENT); | |
} | |
TypedListener typedListener = new TypedListener(listener); | |
addListener(SWT.Selection, typedListener); | |
} | |
/** | |
* Adds a verify key listener. A VerifyKey event is sent by the widget when a key | |
* is pressed. The widget ignores the key press if the listener sets the doit field | |
* of the event to false. | |
* <p> | |
* | |
* @param listener the listener | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_NULL_ARGUMENT when listener is null</li> | |
* </ul> | |
*/ | |
public void addVerifyKeyListener(VerifyKeyListener listener) { | |
checkWidget(); | |
if (listener == null) { | |
SWT.error(SWT.ERROR_NULL_ARGUMENT); | |
} | |
StyledTextListener typedListener = new StyledTextListener(listener); | |
addListener(VerifyKey, typedListener); | |
} | |
/** | |
* Adds a verify listener. A Verify event is sent by the widget when the widget text | |
* is about to change. The listener can set the event text and the doit field to | |
* change the text that is set in the widget or to force the widget to ignore the | |
* text change. | |
* <p> | |
* | |
* @param listener the listener | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_NULL_ARGUMENT when listener is null</li> | |
* </ul> | |
*/ | |
public void addVerifyListener(VerifyListener verifyListener) { | |
checkWidget(); | |
if (verifyListener == null) { | |
SWT.error(SWT.ERROR_NULL_ARGUMENT); | |
} | |
TypedListener typedListener = new TypedListener(verifyListener); | |
addListener(SWT.Verify, typedListener); | |
} | |
/** | |
* Appends a string to the text at the end of the widget. | |
* <p> | |
* | |
* @param string the string to be appended | |
* @see #replaceTextRange(int,int,String) | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_NULL_ARGUMENT when listener is null</li> | |
* </ul> | |
*/ | |
public void append(String string) { | |
checkWidget(); | |
if (string == null) { | |
SWT.error(SWT.ERROR_NULL_ARGUMENT); | |
} | |
int lastChar = Math.max(getCharCount(), 0); | |
replaceTextRange(lastChar, 0, string); | |
} | |
/** | |
* Calculates the width of the widest visible line. | |
*/ | |
void calculateContentWidth() { | |
if (lineHeight != 0) { | |
int itemCount = (int) Math.ceil((float) getClientArea().height / lineHeight); | |
calculateContentWidth(topIndex, Math.min(itemCount, content.getLineCount() - topIndex)); | |
} | |
} | |
/** | |
* Calculates the width of the widget text in the specified line range. | |
* <p> | |
* | |
* @param startline the first line | |
* @param lineCount number of lines to consider for the calculation | |
* @param skipCalculated true=don't recalculated lines that have already been calculated | |
*/ | |
void calculateContentWidth(int startLine, int lineCount) { | |
String line; | |
GC gc = new GC(this); | |
FontData fontData = gc.getFont().getFontData()[0]; | |
int stopLine; | |
if (lineCount < 0) { | |
startLine += lineCount; | |
lineCount *= -1; | |
} | |
stopLine = startLine + lineCount; | |
setLineFont(gc, fontData, SWT.BOLD); | |
for (int i = startLine; i < stopLine; i++) { | |
line = content.getLine(i); | |
contentWidth = Math.max(contentWidth(line, i, gc) + CARET_WIDTH, contentWidth); | |
} | |
gc.dispose(); | |
} | |
/** | |
* Calculates the line height | |
*/ | |
void calculateLineHeight() { | |
GC gc = new GC(this); | |
lineHeight = gc.getFontMetrics().getHeight(); | |
gc.dispose(); | |
} | |
/** | |
* Calculates the width in pixel of a tab character | |
*/ | |
void calculateTabWidth() { | |
StringBuffer tabBuffer = new StringBuffer(tabLength); | |
GC gc = new GC(this); | |
for (int i = 0; i < tabLength; i++) { | |
tabBuffer.append(' '); | |
} | |
tabWidth = gc.stringExtent(tabBuffer.toString()).x; | |
gc.dispose(); | |
} | |
/** | |
* Calculates the scroll bars | |
*/ | |
void calculateScrollBars() { | |
ScrollBar horizontalBar = getHorizontalBar(); | |
ScrollBar verticalBar = getVerticalBar(); | |
setScrollBars(); | |
if (verticalBar != null) { | |
verticalBar.setIncrement(getVerticalIncrement()); | |
} | |
if (horizontalBar != null) { | |
horizontalBar.setIncrement(getHorizontalIncrement()); | |
} | |
} | |
/** | |
* Hides the scroll bars if widget is created in single line mode. | |
*/ | |
static int checkStyle(int style) { | |
if ((style & SWT.SINGLE) != 0) { | |
style &= ~(SWT.H_SCROLL | SWT.V_SCROLL); | |
} | |
return style; | |
} | |
/** | |
* Scrolls down the text to use new space made available by a resize or by | |
* deleted lines. | |
*/ | |
void claimBottomFreeSpace() { | |
int clientAreaItemCount = getLineCountWhole(); | |
int topIndex = getTopIndex(); | |
int newTopIndex; | |
int lastItemIndex = content.getLineCount() - topIndex; | |
if (topIndex > 0 && | |
lastItemIndex > 0 && | |
lastItemIndex < clientAreaItemCount) { | |
newTopIndex = Math.max(0, topIndex - (clientAreaItemCount - lastItemIndex)); | |
setTopIndex(newTopIndex); | |
} | |
} | |
/** | |
* Scrolls text to the right to use new space made available by a resize. | |
*/ | |
void claimRightFreeSpace() { | |
int newHorizontalOffset = Math.max(0, contentWidth - getClientArea().width); | |
if (newHorizontalOffset < horizontalScrollOffset) { | |
// item is no longer drawn past the right border of the client area | |
// align the right end of the item with the right border of the | |
// client area (window is scrolled right). | |
scrollHorizontalBar(newHorizontalOffset - horizontalScrollOffset); | |
} | |
} | |
/** | |
* Removes the widget selection. | |
* <p> | |
* | |
* @param sendEvent a Selection event is sent when set to true and when the selection is actually reset. | |
*/ | |
void clearSelection(boolean sendEvent) { | |
int selectionStart = selection.x; | |
int selectionEnd = selection.y; | |
int length = content.getCharCount(); | |
resetSelection(); | |
// redraw old selection, if any | |
if (selectionEnd - selectionStart > 0) { | |
// called internally to remove selection after text is removed | |
// therefore make sure redraw range is valid. | |
int redrawStart = Math.min(selectionStart, length); | |
int redrawEnd = Math.min(selectionEnd, length); | |
if (redrawEnd - redrawStart > 0) { | |
redrawRange(redrawStart, redrawEnd - redrawStart, true); | |
} | |
if (sendEvent == true) { | |
sendSelectionEvent(); | |
} | |
} | |
} | |
/** | |
* Computes the preferred size. | |
* | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public Point computeSize (int wHint, int hHint, boolean changed) { | |
checkWidget(); | |
int count, width, height, lineHeight; | |
boolean singleLine = (getStyle() & SWT.SINGLE) != 0; | |
lineHeight = getLineHeight(); | |
count = content.getLineCount(); | |
// If a height or width has been specified (via hHint and wHint), | |
// use those values. Otherwise calculate the size based on the | |
// text that is defined. | |
if (hHint != SWT.DEFAULT) { | |
height = hHint; | |
} else { | |
if (singleLine) count = 1; | |
height = count * lineHeight; | |
} | |
if (wHint != SWT.DEFAULT) { | |
width = wHint; | |
} else { | |
// Only calculate what can actually be displayed. | |
// Do this because measuring each text line is a | |
// time-consuming process. | |
int visibleCount = Math.min (count, getDisplay().getBounds().width / lineHeight); | |
calculateContentWidth(0, visibleCount); | |
width = contentWidth; | |
} | |
// Use default values if no text is defined. | |
if (width == 0) width = DEFAULT_WIDTH; | |
if (height == 0) { | |
if (singleLine) height = getLineHeight(); | |
else height = DEFAULT_HEIGHT; | |
} | |
// Hardcode the inset margins. Assume text is inset | |
// 1 pixel on each side. | |
width += 2; | |
height += 2; | |
Rectangle rect = computeTrim(0,0,width,height); | |
return new Point (rect.width, rect.height); | |
} | |
/** | |
* Returns the width of the specified text. Expand tabs to tab stops using | |
* the widget tab width. | |
* This is a quick and inaccurate measurement. Text styles are not taken | |
* into consideration. The gc should be setup to reflect the widest | |
* possible font style. | |
* <p> | |
* | |
* @param text text to be measured. | |
* @param lineIndex index of the line. | |
* @param gc GC to use for measuring text | |
* @return width of the text with tabs expanded to tab stops | |
*/ | |
int contentWidth(String text, int lineIndex, GC gc) { | |
int paintX = 0; | |
int textLength = text.length(); | |
for (int i = 0; i < textLength; i++) { | |
int tabIndex = text.indexOf(TAB, i); | |
// is tab not present or past the rendering range? | |
if (tabIndex == -1 || tabIndex > textLength) { | |
tabIndex = textLength; | |
} | |
if (tabIndex != i) { | |
String tabSegment = text.substring(i, tabIndex); | |
paintX += gc.stringExtent(tabSegment).x; | |
if (tabIndex != textLength && tabWidth > 0) { | |
paintX += tabWidth; | |
paintX -= paintX % tabWidth; | |
} | |
i = tabIndex; | |
} | |
else | |
if (tabWidth > 0) { | |
paintX += tabWidth; | |
paintX -= paintX % tabWidth; | |
} | |
} | |
return paintX; | |
} | |
/** | |
* Copies the selected text to the clipboard. The text will be put in the | |
* clipboard in plain text format and RTF format. | |
* <p> | |
* | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public void copy(){ | |
checkWidget(); | |
int length = selection.y - selection.x; | |
if (length > 0) { | |
RTFTransfer rtfTransfer = RTFTransfer.getInstance(); | |
TextTransfer plainTextTransfer = TextTransfer.getInstance(); | |
RTFWriter rtfWriter = new RTFWriter(selection.x, length); | |
TextWriter plainTextWriter = new TextWriter(selection.x, length); | |
String rtfText = getPlatformDelimitedText(rtfWriter); | |
String plainText = getPlatformDelimitedText(plainTextWriter); | |
try { | |
clipboard.setContents( | |
new String[]{rtfText, plainText}, | |
new Transfer[]{rtfTransfer, plainTextTransfer}); | |
} | |
catch (SWTError error) { | |
// Copy to clipboard failed. This happens when another application | |
// is accessing the clipboard while we copy. Ignore the error. | |
// Fixes 1GDQAVN | |
} | |
} | |
} | |
/** | |
* Returns a string that uses only the line delimiter specified by the | |
* StyledTextContent implementation. | |
* Returns only the first line if the widget has the SWT.SINGLE style. | |
* <p> | |
* | |
* @param text the text that may have line delimiters that don't | |
* match the model line delimiter. Possible line delimiters | |
* are CR ('\r'), LF ('\n'), CR/LF ("\r\n") | |
* @return the converted text that only uses the line delimiter | |
* specified by the model. Returns only the first line if the widget | |
* has the SWT.SINGLE style. | |
*/ | |
String getModelDelimitedText(String text) { | |
StringBuffer convertedText; | |
String delimiter = getLineDelimiter(); | |
int length = text.length(); | |
int crIndex = 0; | |
int lfIndex = 0; | |
int i = 0; | |
if (length == 0) { | |
return text; | |
} | |
convertedText = new StringBuffer(length); | |
while (i < length) { | |
if (crIndex != -1) { | |
crIndex = text.indexOf(SWT.CR, i); | |
} | |
if (lfIndex != -1) { | |
lfIndex = text.indexOf(SWT.LF, i); | |
} | |
if (lfIndex == -1 && crIndex == -1) { // no more line breaks? | |
break; | |
} | |
else // CR occurs before LF or no LF present? | |
if ((crIndex < lfIndex && crIndex != -1) || lfIndex == -1) { | |
convertedText.append(text.substring(i, crIndex)); | |
if (lfIndex == crIndex + 1) { // CR/LF combination? | |
i = lfIndex + 1; | |
} | |
else { | |
i = crIndex + 1; | |
} | |
} | |
else { // LF occurs before CR! | |
convertedText.append(text.substring(i, lfIndex)); | |
i = lfIndex + 1; | |
} | |
if (isSingleLine()) { | |
break; | |
} | |
convertedText.append(delimiter); | |
} | |
// copy remaining text if any and if not in single line mode or no | |
// text copied thus far (because there only is one line) | |
if (i < length && (isSingleLine() == false || convertedText.length() == 0)) { | |
convertedText.append(text.substring(i)); | |
} | |
return convertedText.toString(); | |
} | |
/** | |
* Creates default key bindings. | |
*/ | |
void createKeyBindings() { | |
// Navigation | |
setKeyBinding(SWT.ARROW_UP, ST.LINE_UP); | |
setKeyBinding(SWT.ARROW_DOWN, ST.LINE_DOWN); | |
setKeyBinding(SWT.HOME, ST.LINE_START); | |
setKeyBinding(SWT.END, ST.LINE_END); | |
setKeyBinding(SWT.ARROW_LEFT, ST.COLUMN_PREVIOUS); | |
setKeyBinding(SWT.ARROW_RIGHT, ST.COLUMN_NEXT); | |
setKeyBinding(SWT.PAGE_UP, ST.PAGE_UP); | |
setKeyBinding(SWT.PAGE_DOWN, ST.PAGE_DOWN); | |
setKeyBinding(SWT.ARROW_LEFT | SWT.CTRL, ST.WORD_PREVIOUS); | |
setKeyBinding(SWT.ARROW_RIGHT | SWT.CTRL, ST.WORD_NEXT); | |
setKeyBinding(SWT.HOME | SWT.CTRL, ST.TEXT_START); | |
setKeyBinding(SWT.END | SWT.CTRL, ST.TEXT_END); | |
setKeyBinding(SWT.PAGE_UP | SWT.CTRL, ST.WINDOW_START); | |
setKeyBinding(SWT.PAGE_DOWN | SWT.CTRL, ST.WINDOW_END); | |
// Selection | |
setKeyBinding(SWT.ARROW_UP | SWT.SHIFT, ST.SELECT_LINE_UP); | |
setKeyBinding(SWT.ARROW_DOWN | SWT.SHIFT, ST.SELECT_LINE_DOWN); | |
setKeyBinding(SWT.HOME | SWT.SHIFT, ST.SELECT_LINE_START); | |
setKeyBinding(SWT.END | SWT.SHIFT, ST.SELECT_LINE_END); | |
setKeyBinding(SWT.ARROW_LEFT | SWT.SHIFT, ST.SELECT_COLUMN_PREVIOUS); | |
setKeyBinding(SWT.ARROW_RIGHT | SWT.SHIFT, ST.SELECT_COLUMN_NEXT); | |
setKeyBinding(SWT.PAGE_UP | SWT.SHIFT, ST.SELECT_PAGE_UP); | |
setKeyBinding(SWT.PAGE_DOWN | SWT.SHIFT, ST.SELECT_PAGE_DOWN); | |
setKeyBinding(SWT.ARROW_LEFT | SWT.CTRL | SWT.SHIFT, ST.SELECT_WORD_PREVIOUS); | |
setKeyBinding(SWT.ARROW_RIGHT | SWT.CTRL | SWT.SHIFT, ST.SELECT_WORD_NEXT); | |
setKeyBinding(SWT.HOME | SWT.CTRL | SWT.SHIFT, ST.SELECT_TEXT_START); | |
setKeyBinding(SWT.END | SWT.CTRL | SWT.SHIFT, ST.SELECT_TEXT_END); | |
setKeyBinding(SWT.PAGE_UP | SWT.CTRL | SWT.SHIFT, ST.SELECT_WINDOW_START); | |
setKeyBinding(SWT.PAGE_DOWN | SWT.CTRL | SWT.SHIFT, ST.SELECT_WINDOW_END); | |
// Modification | |
// Cut, Copy, Paste | |
// CUA style | |
setKeyBinding('\u0018' | SWT.CTRL, ST.CUT); | |
setKeyBinding('\u0003' | SWT.CTRL, ST.COPY); | |
setKeyBinding('\u0016' | SWT.CTRL, ST.PASTE); | |
// Wordstar style | |
setKeyBinding(SWT.DEL | SWT.SHIFT, ST.CUT); | |
setKeyBinding(SWT.INSERT | SWT.CTRL, ST.COPY); | |
setKeyBinding(SWT.INSERT | SWT.SHIFT, ST.PASTE); | |
setKeyBinding(SWT.BS, ST.DELETE_PREVIOUS); | |
setKeyBinding(SWT.DEL, ST.DELETE_NEXT); | |
// Miscellaneous | |
setKeyBinding(SWT.INSERT, ST.TOGGLE_OVERWRITE); | |
} | |
/** | |
* Moves the selected text to the clipboard. The text will be put in the | |
* clipboard in plain text format and RTF format. | |
* <p> | |
* | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public void cut(){ | |
checkWidget(); | |
if (selection.y > selection.x) { | |
copy(); | |
doDelete(); | |
} | |
} | |
/** | |
* A mouse move event has occurred. See if we should start autoscrolling. If | |
* the move position is outside of the client area, initiate autoscrolling. | |
* Otherwise, we've moved back into the widget so end autoscrolling. | |
*/ | |
void doAutoScroll(Event event) { | |
Rectangle area = getClientArea(); | |
if (event.y > area.height) doAutoScroll(SWT.DOWN); | |
else if (event.y < 0) doAutoScroll(SWT.UP); | |
else if (event.x < 0) doAutoScroll(SWT.LEFT); | |
else if (event.x > area.width) doAutoScroll(SWT.RIGHT); | |
else endAutoScroll(); | |
} | |
/** | |
* Initiates autoscrolling. | |
* <p> | |
* | |
* @param direction SWT.UP, SWT.DOWN, SWT.RIGHT, SWT.LEFT | |
*/ | |
void doAutoScroll(int direction) { | |
Runnable timer = null; | |
final int TIMER_INTERVAL = 5; | |
// If we're already autoscrolling in the given direction do nothing | |
if (autoScrollDirection == direction) { | |
return; | |
} | |
final Display display = getDisplay(); | |
// Set a timer that will simulate the user pressing and holding | |
// down a cursor key (i.e., arrowUp, arrowDown). | |
if (direction == SWT.UP) { | |
timer = new Runnable() { | |
public void run() { | |
if (autoScrollDirection == SWT.UP) { | |
doLineUp(); | |
doSelection(SWT.LEFT); | |
display.timerExec(TIMER_INTERVAL, this); | |
} | |
} | |
}; | |
} else if (direction == SWT.DOWN) { | |
timer = new Runnable() { | |
public void run() { | |
if (autoScrollDirection == SWT.DOWN) { | |
doLineDown(); | |
doSelection(SWT.RIGHT); | |
display.timerExec(TIMER_INTERVAL, this); | |
} | |
} | |
}; | |
} else if (direction == SWT.RIGHT) { | |
timer = new Runnable() { | |
public void run() { | |
if (autoScrollDirection == SWT.RIGHT) { | |
doColumnRight(); | |
doSelection(SWT.RIGHT); | |
display.timerExec(TIMER_INTERVAL, this); | |
} | |
} | |
}; | |
} else if (direction == SWT.LEFT) { | |
timer = new Runnable() { | |
public void run() { | |
if (autoScrollDirection == SWT.LEFT) { | |
doColumnLeft(); | |
doSelection(SWT.LEFT); | |
display.timerExec(TIMER_INTERVAL, this); | |
} | |
} | |
}; | |
} | |
if (timer != null) { | |
autoScrollDirection = direction; | |
display.timerExec(TIMER_INTERVAL, timer); | |
} | |
} | |
/** | |
* Deletes the character to the left of the caret. Delete the selected text if any. | |
* Move the caret in front of the deleted text. | |
*/ | |
void doBackspace() { | |
Event event = new Event(); | |
event.text = ""; | |
if (selection.x != selection.y) { | |
event.start = selection.x; | |
event.end = selection.y; | |
sendKeyEvent(event); | |
} | |
else | |
if (caretOffset > 0) { | |
int line = content.getLineAtOffset(caretOffset); | |
int lineOffset = content.getOffsetAtLine(line); | |
if (caretOffset == lineOffset) { | |
lineOffset = content.getOffsetAtLine(line - 1); | |
event.start = lineOffset + content.getLine(line - 1).length(); | |
event.end = caretOffset; | |
} | |
else { | |
event.start = caretOffset - 1; | |
event.end = caretOffset; | |
} | |
sendKeyEvent(event); | |
} | |
claimBottomFreeSpace(); | |
} | |
/** | |
* Moves the caret to the start of the selection if a selection exists. | |
* Otherwise, if no selection exists move the cursor according to the | |
* cursor selection rules. | |
* <p> | |
* | |
* @see #doSelectionCursorLeft | |
*/ | |
void doCursorLeft() { | |
if (selection.y - selection.x > 0) { | |
caretOffset = selection.x; | |
showCaret(); | |
} | |
else { | |
doSelectionCursorLeft(); | |
} | |
} | |
/** | |
* Moves the caret to the end of the selection if a selection exists. | |
* Otherwise, if no selection exists move the cursor according to the | |
* cursor selection rules. | |
* <p> | |
* | |
* @see #doSelectionCursorRight | |
*/ | |
void doCursorRight() { | |
if (selection.y - selection.x > 0) { | |
caretOffset = selection.y; | |
showCaret(); | |
} | |
else { | |
doSelectionCursorRight(); | |
} | |
} | |
/** | |
* Moves the caret one character to the left. Do not go to the previous line. | |
*/ | |
void doColumnLeft() { | |
int line = content.getLineAtOffset(caretOffset); | |
int lineOffset = content.getOffsetAtLine(line); | |
int offsetInLine = caretOffset - lineOffset; | |
if (offsetInLine > 0) { | |
caretOffset--; | |
showCaret(); | |
} | |
} | |
/** | |
* Moves the caret one character to the right. Do not go to the next line. | |
*/ | |
void doColumnRight() { | |
int line = content.getLineAtOffset(caretOffset); | |
int lineOffset = content.getOffsetAtLine(line); | |
int offsetInLine = caretOffset - lineOffset; | |
if (offsetInLine < content.getLine(line).length()) { | |
caretOffset++; | |
showCaret(); | |
} | |
} | |
/** | |
* Replaces the selection with the character or insert the character at the | |
* current caret position if no selection exists. | |
* If a carriage return was typed replace it with the line break character | |
* used by the widget on this platform. | |
* <p> | |
* | |
* @param key the character typed by the user | |
*/ | |
void doContent(char key) { | |
Event event; | |
if (textLimit > 0 && content.getCharCount() - (selection.y - selection.x) >= textLimit) { | |
return; | |
} | |
event = new Event(); | |
event.start = selection.x; | |
event.end = selection.y; | |
// replace a CR line break with the widget line break | |
// CR does not make sense on Windows since most (all?) applications | |
// don't recognize CR as a line break. | |
if (key == SWT.CR || key == SWT.LF) { | |
if (isSingleLine() == false) { | |
event.text = getLineDelimiter(); | |
} | |
} | |
// no selection and overwrite mode is on and the typed key is not a | |
// tab character (tabs are always inserted without overwriting)? | |
else | |
if (selection.x == selection.y && overwrite == true && key != TAB) { | |
int lineIndex = content.getLineAtOffset(event.end); | |
int lineOffset = content.getOffsetAtLine(lineIndex); | |
String line = content.getLine(lineIndex); | |
// replace character at caret offset if the caret is not at the | |
// end of the line | |
if (event.end < lineOffset + line.length()) { | |
event.end++; | |
} | |
event.text = new String(new char[] {key}); | |
} | |
else { | |
event.text = new String(new char[] {key}); | |
} | |
if (event.text != null) { | |
sendKeyEvent(event); | |
} | |
} | |
/** | |
* Moves the caret after the last character of the widget content. | |
*/ | |
void doContentEnd() { | |
int length = content.getCharCount(); | |
if (caretOffset < length) { | |
caretOffset = length; | |
showCaret(); | |
} | |
} | |
/** | |
* Moves the caret in front of the first character of the widget content. | |
*/ | |
void doContentStart() { | |
if (caretOffset > 0) { | |
caretOffset = 0; | |
showCaret(); | |
} | |
} | |
/** | |
* Deletes the character to the right of the caret. Delete the selected text if any. | |
*/ | |
void doDelete() { | |
Event event = new Event(); | |
event.text = ""; | |
if (selection.x != selection.y) { | |
event.start = selection.x; | |
event.end = selection.y; | |
sendKeyEvent(event); | |
} | |
else | |
if (caretOffset < content.getCharCount()) { | |
int line = content.getLineAtOffset(caretOffset); | |
int lineOffset = content.getOffsetAtLine(line); | |
int lineLength = content.getLine(line).length(); | |
if (caretOffset == lineOffset + lineLength) { | |
event.start = caretOffset; | |
event.end = content.getOffsetAtLine(line + 1); | |
} | |
else { | |
event.start = caretOffset; | |
event.end = caretOffset + 1; | |
} | |
sendKeyEvent(event); | |
} | |
claimBottomFreeSpace(); | |
} | |
/** | |
* Moves the caret one line down and to the same character offset relative | |
* to the beginning of the line. Move the caret to the end of the new line | |
* if the new line is shorter than the character offset. | |
* Make the new caret position visible. | |
*/ | |
void doLineDown() { | |
doSelectionLineDown(); | |
showCaret(); | |
} | |
/** | |
* Moves the caret to the end of the line. | |
*/ | |
void doLineEnd() { | |
int line = content.getLineAtOffset(caretOffset); | |
int lineOffset = content.getOffsetAtLine(line); | |
int lineLength = content.getLine(line).length(); | |
int lineEndOffset = lineOffset + lineLength; | |
if (caretOffset < lineEndOffset) { | |
caretOffset = lineEndOffset; | |
showCaret(); | |
} | |
} | |
/** | |
* Moves the caret to the beginning of the line. | |
*/ | |
void doLineStart() { | |
int line = content.getLineAtOffset(caretOffset); | |
int lineOffset = content.getOffsetAtLine(line); | |
if (caretOffset > lineOffset) { | |
caretOffset = lineOffset; | |
showCaret(); | |
} | |
else // move up one line to remove line selection | |
if (line > 0 && selection.x < caretOffset) { | |
line--; | |
caretOffset = content.getOffsetAtLine(line); | |
showCaret(); | |
} | |
} | |
/** | |
* Moves the caret one line up and to the same character offset relative | |
* to the beginning of the line. Move the caret to the end of the new line | |
* if the new line is shorter than the character offset. | |
*/ | |
void doLineUp() { | |
int line = content.getLineAtOffset(caretOffset); | |
int lineOffset = content.getOffsetAtLine(line); | |
int offsetInLine = caretOffset - lineOffset; | |
if (line > 0) { | |
line--; | |
lineOffset = content.getOffsetAtLine(line); | |
int lineLength = content.getLine(line).length(); | |
if (offsetInLine > lineLength) { | |
offsetInLine = lineLength; | |
} | |
caretOffset = lineOffset + offsetInLine; | |
showCaret(); | |
} | |
} | |
/** | |
* Moves the caret to the specified location. | |
* <p> | |
* | |
* @param x x location of the new caret position | |
* @param y y location of the new caret position | |
* @param select the location change is a selection operation. | |
* include the line delimiter in the selection | |
*/ | |
void doMouseLocationChange(int x, int y, boolean select) { | |
int line = (y + verticalScrollOffset) / getLineHeight(); | |
int lineCount = content.getLineCount(); | |
if (line > lineCount - 1) { | |
line = lineCount - 1; | |
} | |
if (line >= 0) { | |
String lineText = content.getLine(line); | |
int offsetInLine = -1; | |
int newCaretOffset; | |
int lineOffset = content.getOffsetAtLine(line); | |
if (select && selectionAnchor == lineOffset && line < lineCount - 1) { | |
GC gc = new GC(this); | |
int lineLength = lineText.length(); | |
// represent the line break as one additional white space | |
// if the selection mouse event occurs beyond the line end | |
if (x + horizontalScrollOffset > textWidth(lineText, line, lineLength, gc)) { | |
line++; | |
offsetInLine = 0; | |
lineOffset = content.getOffsetAtLine(line); | |
} | |
gc.dispose(); | |
} | |
if (offsetInLine == -1) { | |
offsetInLine = getOffsetAtX(lineText, lineOffset, x); | |
} | |
newCaretOffset = lineOffset + offsetInLine; | |
if (newCaretOffset != caretOffset) { | |
caretOffset = newCaretOffset; | |
if (select) { | |
doMouseSelection(); | |
} | |
showCaret(); | |
} | |
if (select == false) { | |
clearSelection(true); | |
} | |
} | |
} | |
/** | |
* Updates the selection based on the caret position | |
*/ | |
void doMouseSelection() { | |
if (caretOffset <= selection.x || (caretOffset > selection.x && caretOffset < selection.y && selectionAnchor == selection.x)) { | |
doSelection(SWT.LEFT); | |
} | |
else { | |
doSelection(SWT.RIGHT); | |
} | |
} | |
/** | |
* Scrolls one page down so that the last line (truncated or whole) | |
* of the current page becomes the fully visible top line. | |
* The caret is scrolled the same number of lines so that its location | |
* relative to the top line remains the same. The exception is the end | |
* of the text where a full page scroll is not possible. In this case the | |
* caret is moved after the last character. | |
* <p> | |
* | |
* @param select whether or not to select the page | |
*/ | |
void doPageDown(boolean select) { | |
int line = content.getLineAtOffset(caretOffset); | |
int lineCount = content.getLineCount(); | |
if (line < lineCount) { | |
int lineOffset = content.getOffsetAtLine(line); | |
int offsetInLine = caretOffset - lineOffset; | |
int lineLength; | |
int verticalMaximum = content.getLineCount() * getVerticalIncrement(); | |
int pageSize = getClientArea().height; | |
int scrollLines = Math.min(lineCount - line - 1, getLineCountWhole() - 1); | |
int scrollOffset; | |
line += scrollLines; | |
lineOffset = content.getOffsetAtLine(line); | |
lineLength = content.getLine(line).length(); | |
// set cursor to end of line if cursor would be beyond the end | |
// of line or if page down goes to last line | |
if (offsetInLine > lineLength || line == lineCount - 1) { | |
offsetInLine = lineLength; | |
} | |
caretOffset = lineOffset + offsetInLine; | |
if (select) { | |
doSelection(SWT.RIGHT); | |
} | |
// scroll one page down or to the bottom | |
scrollOffset = verticalScrollOffset + scrollLines * getVerticalIncrement(); | |
if (scrollOffset + pageSize > verticalMaximum) { | |
scrollOffset = verticalMaximum - pageSize; | |
} | |
if (scrollOffset > verticalScrollOffset) { | |
setVerticalScrollOffset(scrollOffset, true); | |
} | |
else { | |
showCaret(); | |
} | |
} | |
} | |
/** | |
* Moves the cursor to the end of the last fully visible line. | |
*/ | |
void doPageEnd() { | |
int line = content.getLineAtOffset(caretOffset); | |
int lineCount = content.getLineCount(); | |
if (line < lineCount) { | |
line = getBottomIndex(); | |
caretOffset = content.getOffsetAtLine(line) + content.getLine(line).length(); | |
showCaret(); | |
} | |
} | |
/** | |
* Moves the cursor to the beginning of the first fully visible line. | |
*/ | |
void doPageStart() { | |
if (content.getLineAtOffset(caretOffset) > topIndex) { | |
caretOffset = content.getOffsetAtLine(topIndex); | |
showCaret(); | |
} | |
} | |
/** | |
* Scrolls one page up so that the first line (truncated or whole) | |
* of the current page becomes the fully visible last line. | |
* The caret is scrolled the same number of lines so that its location | |
* relative to the top line remains the same. The exception is the beginning | |
* of the text where a full page scroll is not possible. In this case the | |
* caret is moved in front of the first character. | |
*/ | |
void doPageUp() { | |
int line = content.getLineAtOffset(caretOffset); | |
if (line > 0) { | |
int lineOffset = content.getOffsetAtLine(line); | |
int offsetInLine = caretOffset - lineOffset; | |
int lineLength; | |
int scrollLines = Math.min(line, getLineCountWhole() - 1); | |
int scrollOffset; | |
line -= scrollLines; | |
lineOffset = content.getOffsetAtLine(line); | |
lineLength = content.getLine(line).length(); | |
// set cursor to start of line if page up goes to first line | |
if (line == 0) { | |
offsetInLine = 0; | |
} | |
else | |
if (offsetInLine > lineLength) { | |
offsetInLine = lineLength; | |
} | |
caretOffset = lineOffset + offsetInLine; | |
// scroll one page up or to the top | |
scrollOffset = Math.max(0, verticalScrollOffset - scrollLines * getVerticalIncrement()); | |
if (scrollOffset < verticalScrollOffset) { | |
setVerticalScrollOffset(scrollOffset, true); | |
} | |
else { | |
showCaret(); | |
} | |
} | |
} | |
/** | |
* Moves the caret one line down and to the same character offset relative | |
* to the beginning of the line. Move the caret to the end of the new line | |
* if the new line is shorter than the character offset. | |
*/ | |
void doSelectionLineDown() { | |
int line = content.getLineAtOffset(caretOffset); | |
int lineOffset = content.getOffsetAtLine(line); | |
int offsetInLine = caretOffset - lineOffset; | |
if (line < content.getLineCount() - 1) { | |
line++; | |
lineOffset = content.getOffsetAtLine(line); | |
int lineLength = content.getLine(line).length(); | |
if (offsetInLine > lineLength) { | |
offsetInLine = lineLength; | |
} | |
caretOffset = lineOffset + offsetInLine; | |
} | |
} | |
/** | |
* Updates the selection to extend to the current caret position. | |
*/ | |
void doSelection(int direction) { | |
int redrawStart = -1; | |
int redrawEnd = -1; | |
if (selectionAnchor == -1) { | |
selectionAnchor = selection.x; | |
} | |
if (direction == SWT.LEFT) { | |
if (caretOffset < selection.x) { | |
// grow selection | |
redrawEnd = selection.x; | |
redrawStart = selection.x = caretOffset; | |
// check if selection has reversed direction | |
if (selection.y != selectionAnchor) { | |
redrawEnd = selection.y; | |
selection.y = selectionAnchor; | |
} | |
} | |
else // test whether selection actually changed. Fixes 1G71EO1 | |
if (selectionAnchor == selection.x && caretOffset < selection.y) { | |
// caret moved towards selection anchor (left side of selection). | |
// shrink selection | |
redrawEnd = selection.y; | |
redrawStart = selection.y = caretOffset; | |
} | |
} | |
else { | |
if (caretOffset > selection.y) { | |
// grow selection | |
redrawStart = selection.y; | |
redrawEnd = selection.y = caretOffset; | |
// check if selection has reversed direction | |
if (selection.x != selectionAnchor) { | |
redrawStart = selection.x; | |
selection.x = selectionAnchor; | |
} | |
} | |
else // test whether selection actually changed. Fixes 1G71EO1 | |
if (selectionAnchor == selection.y && caretOffset > selection.x) { | |
// caret moved towards selection anchor (right side of selection). | |
// shrink selection | |
redrawStart = selection.x; | |
redrawEnd = selection.x = caretOffset; | |
} | |
} | |
if (redrawStart != -1 && redrawEnd != -1) { | |
redrawRange(redrawStart, redrawEnd - redrawStart, true); | |
sendSelectionEvent(); | |
} | |
} | |
/** | |
* Moves the caret one character to the left or to the end of the previous | |
* line if the cursor is at the beginning of a line. | |
*/ | |
void doSelectionCursorLeft() { | |
int line = content.getLineAtOffset(caretOffset); | |
int lineOffset = content.getOffsetAtLine(line); | |
int offsetInLine = caretOffset - lineOffset; | |
if (offsetInLine > 0) { | |
caretOffset--; | |
showCaret(); | |
} | |
else | |
if (line > 0) { | |
line--; | |
lineOffset = content.getOffsetAtLine(line); | |
caretOffset = lineOffset + content.getLine(line).length(); | |
showCaret(); | |
} | |
} | |
/** | |
* Moves the caret one character to the right or to the beginning of the | |
* next line if the cursor is at the end of a line. | |
*/ | |
void doSelectionCursorRight() { | |
int line = content.getLineAtOffset(caretOffset); | |
int lineOffset = content.getOffsetAtLine(line); | |
int offsetInLine = caretOffset - lineOffset; | |
if (offsetInLine < content.getLine(line).length()) { | |
caretOffset++; | |
showCaret(); | |
} | |
else | |
if (line < content.getLineCount() - 1) { | |
line++; | |
caretOffset = content.getOffsetAtLine(line); | |
showCaret(); | |
} | |
} | |
/** | |
* Moves the caret to the beginning of the next line, selecting to the end | |
* of the line plus one whitespace to represent the line break. | |
* Do the regular line selection, if the selection does not start at the | |
* line start or if the last line is being selected. | |
*/ | |
void doSelectionLineEnd() { | |
int line = content.getLineAtOffset(caretOffset); | |
int lineOffset = content.getOffsetAtLine(line); | |
if (selection.x == lineOffset && line < content.getLineCount() - 1) { | |
line++; | |
caretOffset = content.getOffsetAtLine(line); | |
showCaret(); | |
} | |
else { | |
doLineEnd(); | |
} | |
} | |
/** | |
* Moves the caret to the start of the word that is to the left of | |
* the current caret position. | |
* If a selection exists, move the caret to the start of the selection | |
* and remove the selection. | |
*/ | |
void doWordLeft() { | |
if (selection.y - selection.x > 0) { | |
caretOffset = selection.x; | |
showCaret(); | |
} | |
else { | |
doSelectionWordLeft(); | |
} | |
} | |
/** | |
* Moves the caret to the end of the word that is to the right of | |
* the current caret position. | |
* If a selection exists, move the caret to the end of the selection | |
* and remove the selection. | |
*/ | |
void doWordRight() { | |
if (selection.y - selection.x > 0) { | |
caretOffset = selection.y; | |
showCaret(); | |
} | |
else { | |
doSelectionWordRight(); | |
} | |
} | |
/** | |
* Moves the caret to the start of the word that is to the left of | |
* the current caret position. | |
*/ | |
void doSelectionWordLeft() { | |
caretOffset = getWordStart(caretOffset); | |
showCaret(); | |
} | |
/** | |
* Moves the caret to the end of the word that is to the right of | |
* the current caret position. | |
*/ | |
void doSelectionWordRight() { | |
caretOffset = getWordEnd(caretOffset); | |
showCaret(); | |
} | |
/** | |
* Draws the specified rectangle. | |
* Draw directly without invalidating the affected area when a gc is | |
* specified. | |
* <p> | |
* | |
* @param x the x position | |
* @param y the y position | |
* @param width the width | |
* @param height the height | |
* @param gc GC to use for direct drawing. If null the specified area | |
* is invalidated only. | |
* @param clearBackground true=clear the background, false=only draw the foregorund | |
*/ | |
void draw(int x, int y, int width, int height, GC gc, boolean clearBackground) { | |
if (gc == null) { | |
redraw(x, y, width, height, false); | |
} | |
else { | |
int lineHeight = getLineHeight(); | |
int startLine = (y + verticalScrollOffset) / lineHeight; | |
int endY = y + height; | |
int paintYFromTopLine = (startLine - topIndex) * lineHeight; | |
int topLineOffset = (topIndex * lineHeight - verticalScrollOffset); | |
int paintY = paintYFromTopLine + topLineOffset; // adjust y position for pixel based scrolling | |
int lineCount = content.getLineCount(); | |
Color background = getBackground(); | |
Color foreground = getForeground(); | |
if (isSingleLine()) { | |
lineCount = 1; | |
if (startLine > 1) { | |
startLine = 1; | |
} | |
} | |
for (int i = startLine; paintY < endY && i < lineCount; i++, paintY += lineHeight) { | |
String line = content.getLine(i); | |
drawLine(line, i, paintY, gc, background, foreground, clearBackground); | |
} | |
if (clearBackground && paintY < endY) { | |
gc.setBackground(background); | |
gc.setForeground(background); | |
gc.fillRectangle(0, paintY, getClientArea().width, endY - paintY); | |
} | |
} | |
} | |
/** | |
* Draws a line of text at the specified location. | |
* <p> | |
* | |
* @param line the line to draw | |
* @param lineIndex index of the line to draw | |
* @param paintY y location to draw at | |
* @param gc GC to draw on | |
* @param widgetBackground the widget background color. Used as the default rendering color. | |
* @param widgetForeground the widget foreground color. Used as the default rendering color. | |
*/ | |
void drawLine(String line, int lineIndex, int paintY, GC gc, Color widgetBackground, Color widgetForeground, boolean clearBackground) { | |
int lineOffset = content.getOffsetAtLine(lineIndex); | |
int lineLength = line.length(); | |
int selectionEndX = 0; | |
int clientAreaWidth = getClientArea().width; | |
int selectionStartOffset; | |
int selectionEndOffset; | |
int selectionLength; | |
boolean lineSelection; | |
StyleRange[] styles = new StyleRange[0]; | |
Color lineBackground = null; | |
StyledTextEvent event = getLineStyleData(lineOffset, line); | |
if (event != null) { | |
styles = event.styles; | |
} | |
event = getLineBackgroundData(lineOffset, line); | |
if (event != null) { | |
lineBackground = event.lineBackground; | |
} | |
if (lineBackground == null) { | |
lineBackground = widgetBackground; | |
} | |
// calculate offset of selection start and end relative to the line start | |
selectionStartOffset = Math.max(0, selection.x - lineOffset); | |
selectionEndOffset = selection.y - lineOffset; | |
selectionLength = selectionEndOffset - selectionStartOffset; | |
if (selectionLength == 0 || selectionVisible == false) { | |
selectionStartOffset = 0; | |
selectionEndOffset = 0; | |
} | |
lineSelection = selectionEndOffset > 0 && selectionStartOffset <= lineLength; | |
if (lineSelection == false && clearBackground) { | |
// draw background for completely unselected line | |
gc.setBackground(lineBackground); | |
gc.setForeground(lineBackground); | |
gc.fillRectangle(0, paintY, clientAreaWidth, lineHeight); | |
} | |
if (selectionStartOffset > 0) { | |
String unselectedLine; | |
if (selectionStartOffset > lineLength) { | |
unselectedLine = line; | |
} | |
else { | |
if (clearBackground) { | |
// draw background for partially unselected line | |
int selectionStartX = textWidth(line, lineOffset, 0, selectionStartOffset, styles, 0, gc); | |
gc.setBackground(lineBackground); | |
gc.setForeground(lineBackground); | |
gc.fillRectangle(0, paintY, selectionStartX - horizontalScrollOffset, lineHeight); | |
} | |
unselectedLine = line.substring(0, selectionStartOffset); | |
} | |
drawStyledLine(unselectedLine, lineOffset, 0, styles, 0, paintY, gc, lineBackground, widgetForeground); | |
} | |
if (selectionLength > 0 && lineSelection) { | |
// draw selected text | |
selectionEndX = drawLineSelection(line, lineOffset, selectionStartOffset, selectionLength, styles, paintY, gc) - horizontalScrollOffset; | |
if (selectionEndX < clientAreaWidth && clearBackground) { | |
// draw background after selection | |
gc.setBackground(lineBackground); | |
gc.setForeground(lineBackground); | |
gc.fillRectangle(selectionEndX, paintY, clientAreaWidth - selectionEndX, lineHeight); | |
} | |
selectionEndX += horizontalScrollOffset; | |
} | |
if (selectionEndOffset < lineLength) { | |
selectionEndOffset = Math.max(0, selectionEndOffset); | |
drawStyledLine(line, lineOffset, selectionEndOffset, styles, selectionEndX, paintY, gc, lineBackground, widgetForeground); | |
} | |
} | |
/** | |
* Draws the selected part of a line at the specified location. | |
* Draws selected text on top of unselected text. | |
* <p> | |
* | |
* @param line the line to draw | |
* @param lineOffset offset of the first character in the line. | |
* Relative to the start of the document. | |
* @param selectionStartOffset offset of the first selected character. | |
* Relative to the start of the line. | |
* @param selectionLength length, in characters, of the selection. | |
* @param styles line styles | |
* @param paintY y location to draw at | |
* @param gc GC to draw on | |
* @return the x location of the selection end relative to first character location in the line | |
*/ | |
int drawLineSelection(String line, int lineOffset, int selectionStartOffset, int selectionLength, StyleRange[] styles, int paintY, GC gc) { | |
int lineLength = line.length(); | |
int paintX; | |
int selectionBackgroundWidth; | |
styles = filterLineStyles(styles); | |
paintX = textWidth(line, lineOffset, 0, selectionStartOffset, styles, 0, gc); | |
if (selectionStartOffset + selectionLength > lineLength) { | |
selectionLength = lineLength - selectionStartOffset; | |
if ((getStyle() & SWT.FULL_SELECTION) != 0) { | |
// use the greater of the client area width and the content width | |
// fixes 1G8IYRD | |
selectionBackgroundWidth = Math.max(getClientArea().width, contentWidth); | |
} | |
else { | |
// if the selection extends beyond this line, render an | |
// additional whitespace to represent the selected line break | |
selectionBackgroundWidth = textWidth(line + " ", lineOffset, selectionStartOffset, selectionLength + 1, styles, paintX, gc); | |
} | |
} | |
else { | |
selectionBackgroundWidth = textWidth(line, lineOffset, selectionStartOffset, selectionLength, styles, paintX, gc); | |
} | |
gc.setBackground(getSelectionBackground()); | |
gc.setForeground(getSelectionForeground()); | |
// fill the background first since expanded tabs are not | |
// drawn as spaces. tabs just move the draw position. | |
gc.fillRectangle(paintX - horizontalScrollOffset, paintY, selectionBackgroundWidth, lineHeight); | |
drawText(line, lineOffset, selectionStartOffset, selectionLength, styles, paintX, paintY, gc); | |
return paintX + selectionBackgroundWidth; | |
} | |
/** | |
* Draws the line at the specified location. | |
* <p> | |
* | |
* @param line the line to draw | |
* @param lineOffset offset of the first character in the line. | |
* Relative to the start of the document. | |
* @param renderOffset offset of the first character that should be rendered. | |
* Relative to the start of the line. | |
* @param styles the styles to use for rendering line segments. May be empty but not null. | |
* @param paintX x location to draw at | |
* @param paintY y location to draw at | |
* @param gc GC to draw on | |
* @param lineBackground line background color, used when no style is specified for a line segment. | |
* @param lineForeground line foreground color, used when no style is specified for a line segment. | |
*/ | |
void drawStyledLine(String line, int lineOffset, int renderOffset, StyleRange[] styles, int paintX, int paintY, GC gc, Color lineBackground, Color lineForeground) { | |
int lineLength = line.length(); | |
Color background = gc.getBackground(); | |
Color foreground = gc.getForeground(); | |
StyleRange style = null; | |
StyleRange[] filteredStyles = filterLineStyles(styles); | |
int renderStopX = getClientArea().width + horizontalScrollOffset; | |
for (int i = 0; i < styles.length && paintX < renderStopX; i++) { | |
int styleLineLength; | |
int styleLineStart; | |
int styleLineEnd; | |
style = styles[i]; | |
styleLineEnd = style.start + style.length - lineOffset; | |
styleLineStart = Math.max(style.start - lineOffset, 0); | |
// render unstyled text between the start of the current | |
// style range and the end of the previously rendered | |
// style range | |
if (styleLineStart > renderOffset) { | |
background = setLineBackground(gc, background, lineBackground); | |
foreground = setLineForeground(gc, foreground, lineForeground); | |
// don't try to render more text than requested | |
styleLineStart = Math.min(lineLength, styleLineStart); | |
paintX = drawText(line, lineOffset, renderOffset, styleLineStart - renderOffset, filteredStyles, paintX, paintY, gc); | |
renderOffset = styleLineStart; | |
} | |
else | |
if (styleLineEnd <= renderOffset) { | |
// style ends before render start offset | |
// skip to the next style | |
continue; | |
} | |
if (styleLineStart >= lineLength) { | |
// there are line styles but no text for those styles | |
// possible when called with partial line text | |
break; | |
} | |
styleLineLength = Math.min(styleLineEnd, lineLength) - renderOffset; | |
// set style background color if specified | |
if (style.background != null) { | |
background = setLineBackground(gc, background, style.background); | |
foreground = setLineForeground(gc, foreground, style.background); | |
int fillWidth = textWidth(line, lineOffset, renderOffset, styleLineLength, filteredStyles, paintX, gc); | |
gc.fillRectangle(paintX - horizontalScrollOffset, paintY, fillWidth, lineHeight); | |
} | |
else { | |
background = setLineBackground(gc, background, lineBackground); | |
} | |
// set style foreground color if specified | |
if (style.foreground != null) { | |
foreground = setLineForeground(gc, foreground, style.foreground); | |
} | |
else { | |
foreground = setLineForeground(gc, foreground, lineForeground); | |
} | |
paintX = drawText(line, lineOffset, renderOffset, styleLineLength, filteredStyles, paintX, paintY, gc); | |
renderOffset += styleLineLength; | |
} | |
// render unstyled text at the end of the line | |
if ((style == null || renderOffset < lineLength) && paintX < renderStopX) { | |
setLineBackground(gc, background, lineBackground); | |
setLineForeground(gc, foreground, lineForeground); | |
drawText(line, lineOffset, renderOffset, lineLength - renderOffset, filteredStyles, paintX, paintY, gc); | |
} | |
} | |
/** | |
* Draws the text at the specified location. Expands tabs to tab stops using | |
* the widget tab width. | |
* <p> | |
* | |
* @param text text to draw | |
* @param lineOffset offset of the first character in the line. | |
* Relative to the start of the document. | |
* @param startOffset offset of the first character in text to draw | |
* @param length number of characters to draw | |
* @param styles line styles | |
* @param paintX x location to start drawing at | |
* @param paintY y location to draw at | |
* @param gc GC to draw on | |
* @return x location where drawing stopped or 0 if the startOffset or | |
* length is outside the specified text. | |
*/ | |
int drawText(String text, int lineOffset, int startOffset, int length, StyleRange[] lineStyles, int paintX, int paintY, GC gc) { | |
int endOffset = startOffset + length; | |
int textLength = text.length(); | |
StyleRange[] styles; | |
FontData fontData = gc.getFont().getFontData()[0]; | |
if (startOffset < 0 || startOffset >= textLength || startOffset + length > textLength) { | |
return paintX; | |
} | |
for (int i = startOffset; i < endOffset; i++) { | |
int tabIndex = text.indexOf(TAB, i); | |
// is tab not present or past the rendering range? | |
if (tabIndex == -1 || tabIndex > endOffset) { | |
tabIndex = endOffset; | |
} | |
if (tabIndex != i) { | |
String tabSegment = text.substring(i, tabIndex); | |
if (lineStyles != null) { | |
paintX = styledTextWidth(tabSegment, lineOffset + i, lineStyles, paintX, paintY, gc, true); | |
} | |
else { | |
fontData = setLineFont(gc, fontData, SWT.NORMAL); | |
gc.drawString(tabSegment, paintX - horizontalScrollOffset, paintY, true); | |
paintX += gc.stringExtent(tabSegment).x; | |
} | |
if (tabIndex != endOffset && tabWidth > 0) { | |
paintX += tabWidth; | |
paintX -= paintX % tabWidth; | |
} | |
i = tabIndex; | |
} | |
else // is tab at current rendering offset? | |
if (tabWidth > 0) { | |
paintX += tabWidth; | |
paintX -= paintX % tabWidth; | |
} | |
} | |
return paintX; | |
} | |
/** | |
* Ends the autoscroll process. | |
*/ | |
void endAutoScroll() { | |
autoScrollDirection = SWT.NULL; | |
} | |
/** | |
* @param styles styles that may contain font styles. | |
* @return null if the styles contain only regular font styles, the | |
* unchanged styles otherwise. | |
*/ | |
StyleRange[] filterLineStyles(StyleRange[] styles) { | |
if (styles != null) { | |
int styleIndex = 0; | |
while (styleIndex < styles.length && styles[styleIndex].fontStyle == SWT.NORMAL) { | |
styleIndex++; | |
} | |
if (styleIndex == styles.length) { | |
styles = null; | |
} | |
} | |
return styles; | |
} | |
/** | |
* Returns the index of the last fully visible line. | |
* <p> | |
* | |
* @return index of the last fully visible line. | |
*/ | |
int getBottomIndex() { | |
return Math.min(content.getLineCount(), topIndex + getLineCountWhole()) - 1; | |
} | |
/** | |
* Returns the caret position relative to the start of the text. | |
* <p> | |
* | |
* @return the caret position relative to the start of the text. | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public int getCaretOffset() { | |
checkWidget(); | |
return caretOffset; | |
} | |
/** | |
* Returns the content implementation that is used for text storage | |
* or null if no user defined content implementation has been set. | |
* <p> | |
* | |
* @return content implementation that is used for text storage or null | |
* if no user defined content implementation has been set. | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public StyledTextContent getContent() { | |
checkWidget(); | |
return content; | |
} | |
/** | |
* Returns whether the widget implements double click mouse behavior. | |
* <p> | |
* | |
* @return true if double clicking a word selects the word, false if double clicks | |
* have the same effect as regular mouse clicks | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public boolean getDoubleClickEnabled() { | |
checkWidget(); | |
return doubleClickEnabled; | |
} | |
/** | |
* Returns whether the widget content can be edited. | |
* <p> | |
* | |
* @return true if content can be edited, false otherwise | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public boolean getEditable() { | |
checkWidget(); | |
return editable; | |
} | |
/** | |
* Returns the horizontal scroll increment. | |
* <p> | |
* | |
* @return horizontal scroll increment. | |
*/ | |
int getHorizontalIncrement() { | |
GC gc = new GC(this); | |
int increment = gc.getFontMetrics().getAverageCharWidth(); | |
gc.dispose(); | |
return increment; | |
} | |
/** | |
* Returns the horizontal scroll offset relative to the start of the line. | |
* <p> | |
* | |
* @return horizontal scroll offset relative to the start of the line, | |
* measured in character increments starting at 0, if > 0 the content is scrolled | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public int getHorizontalIndex() { | |
checkWidget(); | |
return horizontalScrollOffset / getHorizontalIncrement(); | |
} | |
/** | |
* Returns the horizontal scroll offset relative to the start of the line. | |
* <p> | |
* | |
* @return the horizontal scroll offset relative to the start of the line, | |
* measured in pixel starting at 0, if > 0 the content is scrolled. | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public int getHorizontalPixel() { | |
checkWidget(); | |
return horizontalScrollOffset; | |
} | |
/** | |
* Returns the action assigned to the key. | |
* Returns SWT.NULL if there is no action associated with the key. | |
* <p> | |
* | |
* @param key a key code defined in SWT.java or a character. | |
* Optionally ORd with a state mask (one or more of SWT.CTRL, SWT.SHIFT, SWT.ALT) | |
* @return one of the predefined actions defined in ST.java or SWT.NULL | |
* if there is no action associated with the key. | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public int getKeyBinding(int key) { | |
checkWidget(); | |
Integer action = (Integer) keyActionMap.get(new Integer(key)); | |
int intAction; | |
if (action == null) { | |
intAction = SWT.NULL; | |
} | |
else { | |
intAction = action.intValue(); | |
} | |
return intAction; | |
} | |
/** | |
* Gets the number of characters. | |
* <p> | |
* | |
* @return number of characters in the widget | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public int getCharCount() { | |
checkWidget(); | |
return content.getCharCount(); | |
} | |
/** | |
* Returns the background color of the line at the given index. | |
* Returns null if a LineBackgroundListener has been set or if no background | |
* color has been specified for the line. Should not be called if a | |
* LineBackgroundListener has been set since the listener maintains the | |
* line background colors. | |
* <p> | |
* | |
* @return the background color of the line at the given index. | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_INVALID_ARGUMENT when the index is invalid</li> | |
* </ul> | |
*/ | |
public Color getLineBackground(int index) { | |
checkWidget(); | |
Color lineBackground = null; | |
if (index < 0 || index > content.getLineCount()) { | |
SWT.error(SWT.ERROR_INVALID_ARGUMENT); | |
} | |
if (userLineBackground == false) { | |
lineBackground = defaultLineStyler.getLineBackground(index); | |
} | |
return lineBackground; | |
} | |
/** | |
* Gets the number of text lines. | |
* <p> | |
* | |
* @return the number of lines in the widget | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public int getLineCount () { | |
checkWidget(); | |
return getLineAtOffset(getCharCount()) + 1; | |
} | |
/** | |
* Returns the number of lines that are at least partially displayed in the widget client area. | |
* <p> | |
* | |
* @return number of lines that are at least partially displayed in the widget client area. | |
*/ | |
int getLineCountTruncated() { | |
int lineCount; | |
int lineHeight = getLineHeight(); | |
if (lineHeight != 0) { | |
lineCount = (int) Math.ceil((float) getClientArea().height / lineHeight); | |
} | |
else { | |
lineCount = 1; | |
} | |
return lineCount; | |
} | |
/** | |
* Returns the number of lines that are completely displayed in the widget client area. | |
* <p> | |
* | |
* @return number of lines that are completely displayed in the widget client area. | |
*/ | |
int getLineCountWhole() { | |
int lineCount; | |
int lineHeight = getLineHeight(); | |
if (lineHeight != 0) { | |
lineCount = getClientArea().height / lineHeight; | |
} | |
else { | |
lineCount = 1; | |
} | |
return lineCount; | |
} | |
/** | |
* Returns the line at the specified offset in the text. | |
* 0 <= offset <= getCharCount() so that getLineAtOffset(getCharCount()) | |
* returns the line of the insert location. | |
* <p> | |
* | |
* @param offset offset relative to the start of the content. 0 <= offset <= getCharCount() | |
* @return line at the specified offset in the text | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_INVALID_RANGE when the offset is outside the valid range (< 0 or > getCharCount())</li> | |
* </ul> | |
*/ | |
public int getLineAtOffset(int offset) { | |
checkWidget(); | |
if (offset < 0 || offset > getCharCount()) { | |
SWT.error(SWT.ERROR_INVALID_RANGE); | |
} | |
return content.getLineAtOffset(offset); | |
} | |
/** | |
* Returns the line delimiter used for entering new lines by key down | |
* or paste operation. | |
* <p> | |
* | |
* @return line delimiter used for entering new lines by key down | |
* or paste operation. | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public String getLineDelimiter() { | |
checkWidget(); | |
return content.getLineDelimiter(); | |
} | |
/** | |
* Returns the line height. | |
* <p> | |
* | |
* @return line height in pixel. | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public int getLineHeight() { | |
checkWidget(); | |
if (lineHeight == 0) { | |
calculateLineHeight(); | |
} | |
return lineHeight; | |
} | |
/** | |
* Returns the line style data for the given line or null if there is none. | |
* If there is a LineStyleListener but it does not set any styles, the | |
* StyledTextEvent.styles field will be initialized to an empty array. | |
*/ | |
StyledTextEvent getLineStyleData(int lineOffset, String line) { | |
if (isListening(LineGetStyle)) { | |
StyledTextEvent event = new StyledTextEvent(content); | |
event.detail = lineOffset; | |
event.text = line; | |
notifyListeners(LineGetStyle, event); | |
if (event.styles == null) { | |
event.styles = new StyleRange[0]; | |
} | |
return event; | |
} | |
return null; | |
} | |
/** | |
* Returns the line background data for the given line or null if there is none. | |
*/ | |
StyledTextEvent getLineBackgroundData(int lineOffset, String line) { | |
if (isListening(LineGetBackground)) { | |
StyledTextEvent event = new StyledTextEvent(content); | |
event.detail = lineOffset; | |
event.text = line; | |
notifyListeners(LineGetBackground, event); | |
return event; | |
} | |
return null; | |
} | |
/** | |
* Returns the x, y location of the upper left corner of the character | |
* bounding box at the specified offset in the text. The point is | |
* relative to the upper left corner of the widget client area. | |
* <p> | |
* | |
* @param offset offset relative to the start of the content. | |
* 0 <= offset <= getCharCount() | |
* @return x, y location of the upper left corner of the character | |
* bounding box at the specified offset in the text. | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_INVALID_RANGE when the offset is outside the valid range (< 0 or > getCharCount())</li> | |
* </ul> | |
*/ | |
public Point getLocationAtOffset(int offset) { | |
checkWidget(); | |
if (offset < 0 || offset > getCharCount()) { | |
SWT.error(SWT.ERROR_INVALID_RANGE); | |
} | |
int line = getLineAtOffset(offset); | |
int lineOffset = content.getOffsetAtLine(line); | |
String lineContent = content.getLine(line); | |
int x = getXAtOffset(lineContent, line, offset - lineOffset); | |
int y = line * lineHeight - verticalScrollOffset; | |
return new Point(x, y); | |
} | |
/** | |
* Returns the offset at the given x location in the line. | |
* Doesn't properly handle ligatures and other context dependent characters or | |
* bidi. Ligatures are handled properly as long as they don't occur at lineXOffset. | |
* <p> | |
* | |
* @param line text of the line to calculate the offset in | |
* @param lineOffset offset of the first character in the line. | |
* 0 based from the beginning of the document. | |
* @param lineXOffset x location in the line | |
* @return offset of the character at the x location relative to the start of the | |
* line. | |
*/ | |
int getOffsetAtX(String line, int lineOffset, int lineXOffset) { | |
int x = 0; | |
GC gc = new GC(this); | |
int low = -1; | |
int high = line.length(); | |
int offset; | |
StyleRange[] styles = null; | |
StyledTextEvent event = getLineStyleData(lineOffset, line); | |
if (event != null) { | |
styles = filterLineStyles(event.styles); | |
} | |
lineXOffset += horizontalScrollOffset; | |
while (high - low > 1) { | |
offset = (high + low) / 2; | |
x = textWidth(line, lineOffset, 0, offset, styles, 0, gc); | |
int charWidth = textWidth(line, lineOffset, 0, offset + 1, styles, 0, gc) - x; | |
if (lineXOffset <= x + charWidth / 2) { | |
high = offset; | |
} | |
else { | |
low = offset; | |
} | |
} | |
offset = high; | |
gc.dispose(); | |
return offset; | |
} | |
/** | |
* Returns the index of the last partially visible line. | |
* | |
* @return index of the last partially visible line. | |
*/ | |
int getPartialBottomIndex() { | |
int partialLineCount = (int) Math.ceil((float) getClientArea().height / lineHeight); | |
return Math.min(content.getLineCount(), topIndex + partialLineCount) - 1; | |
} | |
/** | |
* Returns the content in the specified range using the platform line | |
* delimiter to separate lines. | |
* <p> | |
* | |
* @param writer the TextWriter to write line text into | |
* @return the content in the specified range using the platform line | |
* delimiter to separate lines as written by the specified TextWriter. | |
*/ | |
String getPlatformDelimitedText(TextWriter writer) { | |
int end = writer.getStart() + writer.getCharCount(); | |
int startLine = content.getLineAtOffset(writer.getStart()); | |
int endLine = content.getLineAtOffset(end); | |
String endLineText = content.getLine(endLine); | |
int endLineOffset = content.getOffsetAtLine(endLine); | |
for (int i = startLine; i <= endLine; i++) { | |
writer.writeLine(content.getLine(i), content.getOffsetAtLine(i)); | |
if (i < endLine) { | |
writer.writeLineDelimiter(PlatformLineDelimiter); | |
} | |
} | |
if (end > endLineOffset + endLineText.length()) { | |
writer.writeLineDelimiter(PlatformLineDelimiter); | |
} | |
writer.close(); | |
return writer.toString(); | |
} | |
/** | |
* Returns the selection. | |
* <p> | |
* Text selections are specified in terms of caret positions. In a text widget that | |
* contains N characters, there are N+1 caret positions, ranging from 0..N | |
* <p> | |
* | |
* @return start and end of the selection, x is the offset of the first selected | |
* character, y is the offset after the last selected character | |
* @see #getSelectionRange | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public Point getSelection() { | |
checkWidget(); | |
return new Point(selection.x, selection.y); | |
} | |
/** | |
* Returns the selection. | |
* <p> | |
* | |
* @return start and length of the selection, x is the offset of the first selected | |
* character, relative to the first character of the widget content. y is the length | |
* of the selection. | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public Point getSelectionRange() { | |
checkWidget(); | |
return new Point(selection.x, selection.y - selection.x); | |
} | |
/** | |
* Returns the background color to be used for rendering selected text. | |
* <p> | |
* | |
* @return background color to be used for rendering selected text | |
*/ | |
Color getSelectionBackground() { | |
return getDisplay().getSystemColor(SWT.COLOR_LIST_SELECTION); | |
} | |
/** | |
* Gets the number of selected characters. | |
* <p> | |
* | |
* @return the number of selected characters. | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public int getSelectionCount() { | |
checkWidget(); | |
return getSelectionRange().y; | |
} | |
/** | |
* Returns the foreground color to be used for rendering selected text. | |
* <p> | |
* | |
* @return foreground color to be used for rendering selected text | |
*/ | |
Color getSelectionForeground() { | |
return getDisplay().getSystemColor(SWT.COLOR_LIST_SELECTION_TEXT); | |
} | |
/** | |
* Returns the selected text. | |
* <p> | |
* | |
* @return selected text, or an empty String if there is no selection. | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public String getSelectionText() { | |
checkWidget(); | |
return content.getTextRange(selection.x, selection.y - selection.x); | |
} | |
/** | |
* Returns the style range at the given offset. | |
* Returns null if a LineStyleListener has been set or if a style is not set | |
* for the offset. | |
* Should not be called if a LineStyleListener has been set since the | |
* listener maintains the styles. | |
* <p> | |
* | |
* @return a StyleRange with start == offset and length == 1, indicating | |
* the style at the given offset. null if a LineStyleListener has been set | |
* or if a style is not set for the given offset. | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_INVALID_ARGUMENT when the offset is invalid</li> | |
* </ul> | |
*/ | |
public StyleRange getStyleRangeAtOffset(int offset) { | |
checkWidget(); | |
if (offset < 0 || offset > getCharCount()) { | |
SWT.error(SWT.ERROR_INVALID_ARGUMENT); | |
} | |
if (userLineStyle == false) { | |
return defaultLineStyler.getStyleRangeAtOffset(offset); | |
} | |
return null; | |
} | |
/** | |
* Returns the styles. | |
* Returns an empty array if a LineStyleListener has been set. | |
* Should not be called if a LineStyleListener has been set since the | |
* listener maintains the styles. | |
* <p> | |
* | |
* @return the styles or null if a LineStyleListener has been set. | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public StyleRange [] getStyleRanges() { | |
checkWidget(); | |
StyleRange styles[]; | |
if (userLineStyle == false) { | |
styles = defaultLineStyler.getStyleRanges(); | |
} | |
else { | |
styles = new StyleRange[0]; | |
} | |
return styles; | |
} | |
/** | |
* Returns the tab width measured in characters. | |
* | |
* @return tab width measured in characters | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public int getTabs() { | |
checkWidget(); | |
return tabLength; | |
} | |
/** | |
* Returns a copy of the widget content. | |
* <p> | |
* | |
* @return copy of the widget content | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public String getText() { | |
checkWidget(); | |
return content.getTextRange(0, getCharCount()); | |
} | |
/** | |
* Returns the widget content between the two offsets. | |
* <p> | |
* | |
* @param start offset of the first character in the returned String | |
* @param end offset of the last character in the returned String | |
* @return widget content starting at start and ending at end | |
* @see #getTextRange(int,int) | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_INVALID_RANGE when start and/or end are outside the widget content</li> | |
* </ul> | |
*/ | |
public String getText(int start, int end) { | |
checkWidget(); | |
int contentLength = getCharCount(); | |
if (start < 0 || start >= contentLength || end < 0 || end >= contentLength || start > end) { | |
SWT.error(SWT.ERROR_INVALID_RANGE); | |
} | |
return content.getTextRange(start, end - start + 1); | |
} | |
/** | |
* Returns the widget content starting at start for length characters. | |
* <p> | |
* | |
* @param start offset of the first character in the returned String | |
* @param length number of characters to return | |
* @return widget content starting at start and extending length characters. | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_INVALID_RANGE when start and/or length are outside the widget content</li> | |
* </ul> | |
*/ | |
public String getTextRange(int start, int length) { | |
checkWidget(); | |
int contentLength = getCharCount(); | |
int end = start + length; | |
if (start < 0 || start > contentLength || end < 0 || end > contentLength || start > end) { | |
SWT.error(SWT.ERROR_INVALID_RANGE); | |
} | |
return content.getTextRange(start, length); | |
} | |
/** | |
* Gets the text limit. The text limit specifies the amount of text that the user | |
* can type into the widget. | |
* <p> | |
* | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public int getTextLimit() { | |
checkWidget(); | |
return textLimit; | |
} | |
/** | |
* Gets the top index. The top index is the index of the fully visible line that | |
* is currently at the top of the widget. The top index changes when the widget | |
* is scrolled. Indexing is zero based. | |
* <p> | |
* | |
* @return the index of the top line | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public int getTopIndex() { | |
checkWidget(); | |
return topIndex; | |
} | |
/** | |
* Gets the top pixel. The top pixel is the pixel position of the line that is | |
* currently at the top of the widget.The text widget can be scrolled by pixels | |
* by dragging the scroll thumb so that a partial line may be displayed at the top | |
* the widget. The top pixel changes when the widget is scrolled. The top pixel | |
* does not include the widget trimming. | |
* <p> | |
* | |
* @return pixel position of the top line | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public int getTopPixel() { | |
checkWidget(); | |
return verticalScrollOffset; | |
} | |
/** | |
* Returns the vertical scroll increment. | |
* <p> | |
* | |
* @return vertical scroll increment. | |
*/ | |
int getVerticalIncrement() { | |
return getLineHeight(); | |
} | |
/** | |
* Returns the offset of the character after the word at the specified | |
* offset. | |
* <p> | |
* There are two classes of words formed by a sequence of characters: | |
* <ul> | |
* <li>from 0-9 and A-z (ASCII 48-57 and 65-122) | |
* <li>every other character except line breaks | |
* </ul> | |
* </p> | |
* <p> | |
* Space characters ' ' (ASCII 20) are special as they are treated as | |
* part of the word leading up to the space character. Line breaks are | |
* treated as one word. | |
* </p> | |
*/ | |
int getWordEnd(int offset) { | |
int line = content.getLineAtOffset(offset); | |
int lineOffset = content.getOffsetAtLine(line); | |
String lineText = content.getLine(line); | |
int lineLength = lineText.length(); | |
if (offset >= getCharCount()) { | |
return offset; | |
} | |
if (offset == lineOffset + lineLength) { | |
line++; | |
offset = content.getOffsetAtLine(line); | |
} | |
else { | |
offset -= lineOffset; | |
char ch = lineText.charAt(offset); | |
boolean letterOrDigit = Character.isLetterOrDigit(ch); | |
while (offset < lineLength - 1 && Character.isLetterOrDigit(ch) == letterOrDigit) { | |
offset++; | |
ch = lineText.charAt(offset); | |
} | |
// skip over trailing whitespace | |
while (offset < lineLength - 1 && Character.isSpaceChar(ch)) { | |
offset++; | |
ch = lineText.charAt(offset); | |
} | |
if (offset == lineLength - 1 && (Character.isLetterOrDigit(ch) == letterOrDigit || Character.isSpaceChar(ch))) { | |
offset++; | |
} | |
offset += lineOffset; | |
} | |
return offset; | |
} | |
/** | |
* Returns the offset of the character after the word at the specified | |
* offset. | |
* <p> | |
* There are two classes of words formed by a sequence of characters: | |
* <ul> | |
* <li>from 0-9 and A-z (ASCII 48-57 and 65-122) | |
* <li>every other character except line breaks | |
* </ul> | |
* </p> | |
* <p> | |
* Spaces are ignored and do not represent a word. Line breaks are treated | |
* as one word. | |
* </p> | |
*/ | |
int getWordEndNoSpaces(int offset) { | |
int line = content.getLineAtOffset(offset); | |
int lineOffset = content.getOffsetAtLine(line); | |
String lineText = content.getLine(line); | |
int lineLength = lineText.length(); | |
if (offset >= getCharCount()) { | |
return offset; | |
} | |
if (offset == lineOffset + lineLength) { | |
line++; | |
offset = content.getOffsetAtLine(line); | |
} | |
else { | |
offset -= lineOffset; | |
char ch = lineText.charAt(offset); | |
boolean letterOrDigit = Character.isLetterOrDigit(ch); | |
while (offset < lineLength - 1 && Character.isLetterOrDigit(ch) == letterOrDigit && Character.isSpaceChar(ch) == false) { | |
offset++; | |
ch = lineText.charAt(offset); | |
} | |
if (offset == lineLength - 1 && Character.isLetterOrDigit(ch) == letterOrDigit && Character.isSpaceChar(ch) == false) { | |
offset++; | |
} | |
offset += lineOffset; | |
} | |
return offset; | |
} | |
/** | |
* Returns the start offset of the word at the specified offset. | |
* There are two classes of words formed by a sequence of characters: | |
* <p> | |
* <ul> | |
* <li>from 0-9 and A-z (ASCII 48-57 and 65-122) | |
* <li>every other character except line breaks | |
* </ul> | |
* </p> | |
* <p> | |
* Space characters ' ' (ASCII 20) are special as they are treated as | |
* part of the word leading up to the space character. Line breaks are treated | |
* as one word. | |
* </p> | |
*/ | |
int getWordStart(int offset) { | |
int line = content.getLineAtOffset(offset); | |
int lineOffset = content.getOffsetAtLine(line); | |
String lineText = content.getLine(line); | |
if (offset <= 0) { | |
return offset; | |
} | |
if (offset == lineOffset) { | |
line--; | |
lineText = content.getLine(line); | |
offset = content.getOffsetAtLine(line) + lineText.length(); | |
} | |
else { | |
char ch; | |
boolean letterOrDigit; | |
offset -= lineOffset; | |
// skip over trailing whitespace | |
do { | |
offset--; | |
ch = lineText.charAt(offset); | |
} while (offset > 0 && Character.isSpaceChar(ch)); | |
letterOrDigit = Character.isLetterOrDigit(ch); | |
while (offset > 0 && Character.isLetterOrDigit(ch) == letterOrDigit && Character.isSpaceChar(ch) == false) { | |
offset--; | |
ch = lineText.charAt(offset); | |
} | |
if (offset > 0 || Character.isLetterOrDigit(ch) != letterOrDigit) { | |
offset++; | |
} | |
offset += lineOffset; | |
} | |
return offset; | |
} | |
/** | |
* Returns the x location of the character at the give offset in the line. | |
* <b>NOTE:</b> Does not return correct values for true italic fonts (vs. slanted fonts). | |
* <p> | |
* | |
* @return x location of the character at the give offset in the line. | |
*/ | |
int getXAtOffset(String line, int lineIndex, int lineOffset) { | |
int x; | |
if (lineOffset == 0) { | |
x = 0; | |
} | |
else { | |
GC gc = new GC(this); | |
if (lineOffset > line.length()) { | |
// offset is not on the line. return an x location one character | |
// after the line to indicate the line delimiter. | |
line += " "; | |
lineOffset = line.length(); | |
} | |
x = textWidth(line, lineIndex, lineOffset, gc); | |
gc.dispose(); | |
} | |
return x - horizontalScrollOffset; | |
} | |
/** | |
* Inserts a string. The old selection is replaced with the new text. | |
* <p> | |
* | |
* @param string the string | |
* @see #replaceTextRange(int,int,String) | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_NULL_ARGUMENT when listener is null</li> | |
* </ul> | |
*/ | |
public void insert(String string) { | |
checkWidget(); | |
if (string == null) { | |
SWT.error(SWT.ERROR_NULL_ARGUMENT); | |
} | |
Point sel = getSelectionRange(); | |
replaceTextRange(sel.x, sel.y, string); | |
} | |
/** | |
* Creates content change listeners and set the default content model. | |
*/ | |
void installDefaultContent() { | |
textChangeListener = new TextChangeListener() { | |
public void textChanging(TextChangingEvent event) { | |
handleTextChanging(event); | |
} | |
public void textChanged(TextChangedEvent event) { | |
handleTextChanged(event); | |
} | |
public void textSet(TextChangedEvent event) { | |
handleTextSet(event); | |
} | |
}; | |
content = new DefaultContent(); | |
content.addTextChangeListener(textChangeListener); | |
} | |
/** | |
* Creates a default line style listener. | |
* Used to store line background colors and styles. | |
* Removed when the user sets a LineStyleListener. | |
* <p> | |
* | |
* @see #addLineStyleListener | |
*/ | |
void installDefaultLineStyler() { | |
defaultLineStyler = new DefaultLineStyler(content); | |
StyledTextListener typedListener = new StyledTextListener(defaultLineStyler); | |
if (userLineStyle == false) { | |
addListener(LineGetStyle, typedListener); | |
} | |
if (userLineBackground == false) { | |
addListener(LineGetBackground, typedListener); | |
} | |
} | |
/** | |
* Adds event listeners | |
*/ | |
void installListeners() { | |
ScrollBar verticalBar = getVerticalBar(); | |
ScrollBar horizontalBar = getHorizontalBar(); | |
addListener(SWT.Dispose, new Listener() { | |
public void handleEvent(Event event) { | |
handleDispose(); | |
} | |
}); | |
addListener(SWT.KeyDown, new Listener() { | |
public void handleEvent(Event event) { | |
handleKeyDown(event); | |
} | |
}); | |
addListener(SWT.MouseDown, new Listener() { | |
public void handleEvent(Event event) { | |
handleMouseDown(event); | |
} | |
}); | |
addListener(SWT.MouseUp, new Listener() { | |
public void handleEvent(Event event) { | |
handleMouseUp(event); | |
} | |
}); | |
addListener(SWT.MouseDoubleClick, new Listener() { | |
public void handleEvent(Event event) { | |
handleMouseDoubleClick(event); | |
} | |
}); | |
addListener(SWT.MouseMove, new Listener() { | |
public void handleEvent(Event event) { | |
handleMouseMove(event); | |
} | |
}); | |
addListener(SWT.Paint, new Listener() { | |
public void handleEvent(Event event) { | |
handlePaint(event); | |
} | |
}); | |
addListener(SWT.Resize, new Listener() { | |
public void handleEvent(Event event) { | |
handleResize(event); | |
} | |
}); | |
addListener(SWT.Traverse, new Listener() { | |
public void handleEvent(Event event) { | |
// do nothing | |
// hooked to disable automatic tab traversal on tab key press | |
} | |
}); | |
if (verticalBar != null) { | |
verticalBar.addListener(SWT.Selection, new Listener() { | |
public void handleEvent(Event event) { | |
handleVerticalScroll(event); | |
} | |
}); | |
} | |
if (horizontalBar != null) { | |
horizontalBar.addListener(SWT.Selection, new Listener() { | |
public void handleEvent(Event event) { | |
handleHorizontalScroll(event); | |
} | |
}); | |
} | |
} | |
/** | |
* Returns the widget text with style information encoded using RTF format | |
* specification version 1.5. | |
* | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
String getRtf(){ | |
checkWidget(); | |
String rtfText = null; | |
int length = getCharCount(); | |
if (length > 0) { | |
RTFWriter rtfWriter = new RTFWriter(0, length); | |
rtfText = getPlatformDelimitedText(rtfWriter); | |
} | |
return rtfText; | |
} | |
/** | |
* Frees resources. | |
*/ | |
void handleDispose() { | |
Enumeration colors; | |
clipboard.dispose(); | |
ibeamCursor.dispose(); | |
if (boldFont != null) { | |
boldFont.dispose(); | |
} | |
if (content != null) { | |
content.removeTextChangeListener(textChangeListener); | |
} | |
} | |
/** | |
* Updates the caret location and selection if mouse button 1 has been | |
* pressed. | |
*/ | |
void handleMouseDoubleClick(Event event) { | |
if (event.button != 1 || doubleClickEnabled == false) { | |
return; | |
} | |
mouseDoubleClick = true; | |
caretOffset = getWordEndNoSpaces(caretOffset); | |
resetSelection(); | |
caretOffset = getWordStart(caretOffset); | |
showCaret(); | |
doMouseSelection(); | |
} | |
/** | |
* Updates the caret location and selection if mouse button 1 has been | |
* pressed. | |
*/ | |
void handleMouseDown(Event event) { | |
if (event.button != 1) { | |
return; | |
} | |
mouseDoubleClick = false; | |
doMouseLocationChange(event.x, event.y, (event.stateMask & SWT.SHIFT) != 0); | |
} | |
/** | |
* Autoscrolling ends when the mouse button is released. | |
*/ | |
void handleMouseUp(Event event) { | |
endAutoScroll(); | |
} | |
/** | |
* Updates the caret location and selection if mouse button 1 is pressed | |
* during the mouse move. | |
*/ | |
void handleMouseMove(Event event) { | |
if (mouseDoubleClick == true || (event.stateMask & SWT.BUTTON1) == 0) { | |
return; | |
} | |
doMouseLocationChange(event.x, event.y, true); | |
doAutoScroll(event); | |
} | |
/** | |
* Replaces the selection with the clipboard text or insert the text at | |
* the current caret offset if there is no selection. | |
* If the widget has the SWT.SINGLE style and the clipboard text contains | |
* more than one line, only the first line without line delimiters is | |
* inserted in the widget. | |
* <p> | |
* | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public void paste(){ | |
checkWidget(); | |
TextTransfer transfer = TextTransfer.getInstance(); | |
String text; | |
text = (String) clipboard.getContents(transfer); | |
if (text != null && text.length() > 0) { | |
Event event = new Event(); | |
event.start = selection.x; | |
event.end = selection.y; | |
event.text = getModelDelimitedText(text); | |
sendKeyEvent(event); | |
// fixes 1GBKN67 | |
claimBottomFreeSpace(); | |
} | |
} | |
/** | |
* Prints the widget's text to the default printer. | |
* <p> | |
* | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public void print() { | |
checkWidget(); | |
new StyledTextPrinter(this).print(); | |
} | |
/** | |
* Scrolls the widget horizontally. | |
*/ | |
void handleHorizontalScroll(Event event) { | |
int scrollPixel = getHorizontalBar().getSelection() - horizontalScrollOffset; | |
scrollHorizontal(scrollPixel); | |
} | |
/** | |
* If a VerifyKey listener exists, verify that the key that was entered | |
* should be processed. | |
* <p> | |
* | |
* @param event keyboard event | |
*/ | |
void handleKeyDown(Event event) { | |
Event verifyEvent = new Event(); | |
verifyEvent.character = event.character; | |
verifyEvent.keyCode = event.keyCode; | |
verifyEvent.stateMask = event.stateMask; | |
verifyEvent.doit = true; | |
notifyListeners(VerifyKey, verifyEvent); | |
if (verifyEvent.doit == true) { | |
handleKey(event); | |
} | |
} | |
/** | |
* If an action has been registered for the key stroke execute the action. | |
* Otherwise, if a character has been entered treat it as new content. | |
* <p> | |
* | |
* @param event keyboard event | |
*/ | |
void handleKey(Event event) { | |
int action; | |
if (event.keyCode != 0) { | |
action = getKeyBinding(event.keyCode | event.stateMask); | |
} | |
else { | |
action = getKeyBinding(event.character | event.stateMask); | |
} | |
if (action == SWT.NULL) { | |
// ignore anything below SPACE and ignore DEL | |
if (event.character > 31 && event.character != SWT.DEL || | |
event.character == SWT.CR || event.character == SWT.LF || | |
event.character == TAB) { | |
doContent(event.character); | |
} | |
} | |
else { | |
invokeAction(action); | |
} | |
} | |
/** | |
* Renders the invalidated area specified in the paint event. | |
* <p> | |
* | |
* @param event paint event | |
*/ | |
void handlePaint(Event event) { | |
draw(event.x, event.y, event.width, event.height, event.gc, true); | |
} | |
/** | |
* Recalculates the scroll bars. | |
* <p> | |
* | |
* @param event resize event | |
*/ | |
void handleResize(Event event) { | |
ScrollBar verticalBar = getVerticalBar(); | |
int oldHeight = clientAreaHeight; | |
clientAreaHeight = getClientArea().height; | |
if (clientAreaHeight > oldHeight) { | |
int lineCount = content.getLineCount(); | |
int oldBottomIndex = topIndex + oldHeight / lineHeight; | |
int newItemCount = (int) Math.ceil((float) (clientAreaHeight - oldHeight) / lineHeight); | |
oldBottomIndex = Math.min(oldBottomIndex, lineCount); | |
newItemCount = Math.min(newItemCount, lineCount - oldBottomIndex); | |
calculateContentWidth(oldBottomIndex, newItemCount); | |
} | |
setScrollBars(); | |
claimBottomFreeSpace(); | |
claimRightFreeSpace(); | |
} | |
/** | |
* Updates the caret position and selection and the scroll bars to reflect | |
* the content change. | |
* <p> | |
*/ | |
void handleTextChanged(TextChangedEvent event) { | |
int visibleItemCount = (int) Math.ceil((float) getClientArea().height / lineHeight); | |
int firstLine = content.getLineAtOffset(lastTextChangeStart); | |
int stopLine; | |
// calculate width of visible changed lines | |
stopLine = firstLine + lastTextChangeNewLineCount + 1; | |
if (stopLine > topIndex && firstLine < topIndex + visibleItemCount) { | |
int startLine = Math.max(firstLine, topIndex); | |
calculateContentWidth( | |
startLine, | |
Math.min(stopLine, topIndex + visibleItemCount) - startLine); | |
} | |
setScrollBars(); | |
// update selection/caret location after styles have been changed. | |
// otherwise any text measuring could be incorrect | |
// | |
// also, this needs to be done after all scrolling. Otherwise, | |
// selection redraw would be flushed during scroll which is wrong. | |
// in some cases new text would be drawn in scroll source area even | |
// though the intent is to scroll it. | |
// fixes 1GB93QT | |
updateSelection( | |
lastTextChangeStart, | |
lastTextChangeReplaceCharCount, | |
lastTextChangeNewCharCount); | |
int newVerticalOffset = getLineCount() * getLineHeight() - getClientArea().height; | |
if (newVerticalOffset < verticalScrollOffset) { | |
// Scroll up so that empty lines below last text line are used. | |
// Fixes 1GEYJM0 | |
setVerticalScrollOffset(Math.max(0, newVerticalOffset), true); | |
} | |
} | |
/** | |
* Updates the screen to reflect a pending content change. | |
* <p> | |
* | |
* @param event.start the start offset of the change | |
* @param event.newText text that is going to be inserted or empty String | |
* if no text will be inserted | |
* @param event.replaceCharCount length of text that is going to be replaced | |
* @param event.newCharCount length of text that is going to be inserted | |
* @param event.replaceLineCount number of lines that are going to be replaced | |
* @param event.newLineCount number of new lines that are going to be inserted | |
*/ | |
void handleTextChanging(TextChangingEvent event) { | |
int firstLine; | |
int firstLineOffset; | |
int offsetInLine; | |
String firstLineText; | |
int stopLine; | |
boolean isMultiLineChange = event.replaceLineCount > 0 || event.newLineCount > 0; | |
int textChangeX = -1; | |
int textChangeY; | |
int oldTabX = 0; | |
int textChangeStopX = -1; | |
int visibleItemCount = (int) Math.ceil((float) getClientArea().height / lineHeight); | |
if (event.replaceCharCount < 0) { | |
event.start += event.replaceCharCount; | |
event.replaceCharCount *= -1; | |
} | |
lastTextChangeStart = event.start; | |
lastTextChangeNewLineCount = event.newLineCount; | |
lastTextChangeNewCharCount = event.newCharCount; | |
lastTextChangeReplaceCharCount = event.replaceCharCount; | |
firstLine = content.getLineAtOffset(event.start); | |
firstLineText = content.getLine(firstLine); | |
firstLineOffset = content.getOffsetAtLine(firstLine); | |
offsetInLine = event.start - firstLineOffset; | |
if (isMultiLineChange == false) { | |
// get location of nearest tab and replace stop offset in old text | |
int oldTabIndex = firstLineText.indexOf(TAB, offsetInLine + event.replaceCharCount); | |
oldTabX = getXAtOffset(firstLineText, firstLine, oldTabIndex + 1); | |
if (event.newCharCount == 0) { | |
// characters are going to be deleted. find out where the last deleted | |
// character stops drawing. | |
// This will be used in redrawSingleLineChange as the bit blit source | |
// x position. It has to be calculated before the styles are updated | |
// because the deleted text may be bold. If the styles are deleted | |
// before the calculation, the resulting x position would not reflect | |
// the bold style thus causing incorrect blitting to occur. | |
textChangeStopX = getXAtOffset( | |
firstLineText, | |
firstLine, | |
offsetInLine + event.replaceCharCount); | |
} | |
} | |
textChangeY = firstLine * lineHeight - verticalScrollOffset; | |
if (isMultiLineChange) { | |
textChangeX = getXAtOffset(firstLineText, firstLine, offsetInLine); | |
redrawMultiLineChange( | |
textChangeX, | |
textChangeY, | |
event.newLineCount, | |
event.replaceLineCount); | |
// notify default line styler about text change | |
if (defaultLineStyler != null) { | |
defaultLineStyler.textChanging(event); | |
} | |
} | |
else { | |
// get location of nearest tab and replace stop offset in new text | |
int newTabIndex; | |
String newLine; | |
StringBuffer newLineText = new StringBuffer(firstLineText); | |
newLineText.delete(offsetInLine, offsetInLine + event.replaceCharCount); | |
if (event.newText != null && event.newText.length() > 0) { | |
newLineText.insert(offsetInLine, event.newText); | |
} | |
newLine = newLineText.toString(); | |
newTabIndex = newLine.indexOf(TAB, offsetInLine + event.newCharCount); | |
// flush pending redraws before changing the line styles to reflect | |
// the pending text change | |
update(); | |
// notify default line styler about text change | |
if (defaultLineStyler != null) { | |
defaultLineStyler.textChanging(event); | |
} | |
// it is safe to calculate the change start x position after the | |
// styles have been updated since the styles only change behind the | |
// change start offset, not before. | |
textChangeX = getXAtOffset(firstLineText, firstLine, offsetInLine); | |
if (newTabIndex != -1) { | |
// there is at least one tab character after the text change | |
int newTabX = getXAtOffset(newLine, firstLine, newTabIndex + 1); | |
redrawSingleLineTabChange(textChangeX, textChangeY, newTabX, oldTabX); | |
} | |
else { | |
if (textChangeStopX == -1) { | |
// text change stop x position has not been calculated yet. | |
// This means that text is going to be inserted. Calculate | |
// the x position behind the inserted text. It will be used | |
// in redrawSingleLineChange as the bit blit destination x | |
// position. The x position has to be calculated after the | |
// styles have been updated because the calculation uses the | |
// styles of the new text which otherwise may not exist yet. | |
textChangeStopX = getXAtOffset( | |
newLine, | |
firstLine, | |
offsetInLine + event.newCharCount); | |
} | |
redrawSingleLineChange( | |
textChangeX, | |
textChangeY, | |
event.newCharCount, | |
event.replaceCharCount, | |
textChangeStopX); | |
} | |
} | |
} | |
/** | |
* Called when the widget content is set programatically, overwriting | |
* the old content. Resets the caret position, selection and scroll offsets. | |
* Recalculates the content width and scroll bars. Redraws the widget. | |
* <p> | |
* | |
* @param event text change event. | |
*/ | |
void handleTextSet(TextChangedEvent event) { | |
reset(); | |
} | |
/** | |
* Scrolls the widget vertically. | |
*/ | |
void handleVerticalScroll(Event event) { | |
setVerticalScrollOffset(getVerticalBar().getSelection(), false); | |
} | |
/** | |
* Initializes the fonts used to render font styles. | |
* Presently only regular and bold fonts are supported. | |
*/ | |
void initializeFonts() { | |
FontData fontData; | |
regularFont = getFont(); | |
fontData = regularFont.getFontData()[0]; | |
fontData.setStyle(fontData.getStyle() | SWT.BOLD); | |
boldFont = new Font(getDisplay(), fontData); | |
} | |
/** | |
* Executes the action. | |
* <p> | |
* | |
* @param action one of the actions defined in ST.java | |
*/ | |
public void invokeAction(int action) { | |
switch (action) { | |
// Navigation | |
case ST.LINE_UP: | |
doLineUp(); | |
clearSelection(true); | |
break; | |
case ST.LINE_DOWN: | |
doLineDown(); | |
clearSelection(true); | |
break; | |
case ST.LINE_START: | |
doLineStart(); | |
clearSelection(true); | |
break; | |
case ST.LINE_END: | |
doLineEnd(); | |
clearSelection(true); | |
break; | |
case ST.COLUMN_PREVIOUS: | |
doCursorLeft(); | |
clearSelection(true); | |
break; | |
case ST.COLUMN_NEXT: | |
doCursorRight(); | |
clearSelection(true); | |
break; | |
case ST.PAGE_UP: | |
doPageUp(); | |
clearSelection(true); | |
break; | |
case ST.PAGE_DOWN: | |
doPageDown(false); | |
clearSelection(true); | |
break; | |
case ST.WORD_PREVIOUS: | |
doWordLeft(); | |
clearSelection(true); | |
break; | |
case ST.WORD_NEXT: | |
doWordRight(); | |
clearSelection(true); | |
break; | |
case ST.TEXT_START: | |
doContentStart(); | |
clearSelection(true); | |
break; | |
case ST.TEXT_END: | |
doContentEnd(); | |
clearSelection(true); | |
break; | |
case ST.WINDOW_START: | |
doPageStart(); | |
clearSelection(true); | |
break; | |
case ST.WINDOW_END: | |
doPageEnd(); | |
clearSelection(true); | |
break; | |
// Selection | |
case ST.SELECT_LINE_UP: | |
doLineUp(); | |
doSelection(SWT.LEFT); | |
break; | |
case ST.SELECT_LINE_DOWN: | |
doSelectionLineDown(); | |
doSelection(SWT.RIGHT); | |
showCaret(); | |
break; | |
case ST.SELECT_LINE_START: | |
doLineStart(); | |
doSelection(SWT.LEFT); | |
break; | |
case ST.SELECT_LINE_END: | |
doSelectionLineEnd(); | |
doSelection(SWT.RIGHT); | |
break; | |
case ST.SELECT_COLUMN_PREVIOUS: | |
doSelectionCursorLeft(); | |
doSelection(SWT.LEFT); | |
break; | |
case ST.SELECT_COLUMN_NEXT: | |
doSelectionCursorRight(); | |
doSelection(SWT.RIGHT); | |
break; | |
case ST.SELECT_PAGE_UP: | |
doPageUp(); | |
doSelection(SWT.LEFT); | |
break; | |
case ST.SELECT_PAGE_DOWN: | |
doPageDown(true); | |
break; | |
case ST.SELECT_WORD_PREVIOUS: | |
doSelectionWordLeft(); | |
doSelection(SWT.LEFT); | |
break; | |
case ST.SELECT_WORD_NEXT: | |
doSelectionWordRight(); | |
doSelection(SWT.RIGHT); | |
break; | |
case ST.SELECT_TEXT_START: | |
doContentStart(); | |
doSelection(SWT.LEFT); | |
break; | |
case ST.SELECT_TEXT_END: | |
doContentEnd(); | |
doSelection(SWT.RIGHT); | |
break; | |
case ST.SELECT_WINDOW_START: | |
doPageStart(); | |
doSelection(SWT.LEFT); | |
break; | |
case ST.SELECT_WINDOW_END: | |
doPageEnd(); | |
doSelection(SWT.RIGHT); | |
break; | |
// Modification | |
case ST.CUT: | |
cut(); | |
break; | |
case ST.COPY: | |
copy(); | |
break; | |
case ST.PASTE: | |
paste(); | |
break; | |
case ST.DELETE_PREVIOUS: | |
doBackspace(); | |
clearSelection(true); | |
break; | |
case ST.DELETE_NEXT: | |
doDelete(); | |
clearSelection(true); | |
break; | |
// Miscellaneous | |
case ST.TOGGLE_OVERWRITE: | |
overwrite = !overwrite; // toggle insert/overwrite mode | |
break; | |
} | |
} | |
/** | |
* Returns whether the font style in the given style range is changing | |
* from SWT.NORMAL to SWT.BOLD or vice versa. | |
* <p> | |
* | |
* @param range StyleRange to compare current font style with. | |
* @param start offset of the first font style to compare | |
* @param end offset behind the last font style to compare | |
* @return true if the font style is changing in the given style range, | |
* false if the font style is not changing in the given style range. | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
boolean isStyleChanging(StyleRange range, int start, int end) { | |
checkWidget(); | |
int styleChangeOffset = -1; | |
for (int i = start; i < end; i++) { | |
StyleRange style = defaultLineStyler.getStyleRangeAtOffset(i); | |
if ((style != null && style.fontStyle != range.fontStyle) || | |
(style == null && range.fontStyle != SWT.NORMAL)) { | |
return true; | |
} | |
} | |
return false; | |
} | |
/** | |
* Sends the specified verify event, replace/insert text as defined by | |
* the event and send a modify event. | |
* <p> | |
* | |
* @param event the text change event. | |
* <ul> | |
* <li>event.start - the replace start offset</li> | |
* <li>event.end - the replace end offset</li> | |
* <li>event.text - the new text</li> | |
* </ul> | |
* @param updateCaret whether or not he caret should be set behind | |
* the new text | |
*/ | |
void modifyContent(Event event, boolean updateCaret) { | |
event.doit = true; | |
notifyListeners(SWT.Verify, event); | |
if (event.doit) { | |
StyledTextEvent styledTextEvent = null; | |
int replacedLength = event.end - event.start; | |
if (isListening(ExtendedModify)) { | |
styledTextEvent = new StyledTextEvent(content); | |
styledTextEvent.start = event.start; | |
styledTextEvent.end = event.start + event.text.length(); | |
styledTextEvent.text = content.getTextRange(event.start, replacedLength); | |
} | |
content.replaceTextRange(event.start, replacedLength, event.text); | |
// set the caret position prior to sending the modify event. | |
// fixes 1GBB8NJ | |
if (updateCaret) { | |
internalSetSelection(event.start + event.text.length(), 0); | |
// always update the caret location. fixes 1G8FODP | |
showCaret(); | |
} | |
notifyListeners(SWT.Modify, event); | |
if (isListening(ExtendedModify)) { | |
notifyListeners(ExtendedModify, styledTextEvent); | |
} | |
} | |
} | |
/** | |
* Redraws the specified text range. | |
* <p> | |
* | |
* @param start offset of the first character to redraw | |
* @param length number of characters to redraw | |
* @param clearBackground true if the background should be cleared as part of the | |
* redraw operation. If true, the entire redraw area will be cleared before anything | |
* is redrawn. The redraw operation will be faster and smoother if clearBackground | |
* is set to false. Whether or not the flag can be set to false depends on the type | |
* of change that has taken place. If font styles or background colors for the redraw | |
* area have changed, clearBackground should be set to true. If only foreground colors | |
* have changed for the redraw area, clearBackground can be set to false. | |
*/ | |
public void redrawRange(int start, int length, boolean clearBackground) { | |
Rectangle clientArea = getClientArea(); | |
int lineHeight = getLineHeight(); | |
int end = start + length; | |
int firstLine = content.getLineAtOffset(start); | |
int lastLine = content.getLineAtOffset(end); | |
int lineCount = lastLine - firstLine + 1; | |
int redrawX; | |
int redrawStopX; | |
int redrawY; | |
int firstLineOffset; | |
int offsetInFirstLine; | |
int partialBottomIndex = getPartialBottomIndex(); | |
int partialTopIndex = verticalScrollOffset / lineHeight; | |
String line; | |
GC gc = null; | |
// do nothing if redraw range is completely invisible | |
if (firstLine > partialBottomIndex || lastLine < partialTopIndex) { | |
return; | |
} | |
if (clearBackground == false) { | |
gc = new GC(this); | |
} | |
// only redraw visible lines | |
if (partialTopIndex > firstLine) { | |
firstLine = partialTopIndex; | |
firstLineOffset = start = content.getOffsetAtLine(firstLine); | |
offsetInFirstLine = 0; | |
} | |
else { | |
firstLineOffset = content.getOffsetAtLine(firstLine); | |
offsetInFirstLine = start - firstLineOffset; | |
} | |
if (partialBottomIndex + 1 < lastLine) { | |
lastLine = partialBottomIndex + 1; // + 1 to redraw whole bottom line, including line break | |
end = content.getOffsetAtLine(lastLine); | |
} | |
// redraw first line | |
line = content.getLine(firstLine); | |
// calculate redraw start location | |
redrawX = getXAtOffset(line, firstLine, offsetInFirstLine); | |
redrawY = firstLine * lineHeight - verticalScrollOffset; | |
// calculate redraw stop location | |
if ((getStyle() & SWT.FULL_SELECTION) != 0 && lastLine > firstLine) { | |
redrawStopX = clientArea.width; | |
} | |
else { | |
redrawStopX = getXAtOffset(line, firstLine, end - firstLineOffset); | |
} | |
draw(redrawX, redrawY, redrawStopX - redrawX, lineHeight, gc, clearBackground); | |
firstLine++; // first line has been redrawn. | |
// redraw last line if more than line needs redrawing | |
if (lineCount > 1) { | |
int offsetInLastLine = end - content.getOffsetAtLine(lastLine); | |
// no redraw necessary if redraw offset is 0 | |
if (offsetInLastLine > 0) { | |
line = content.getLine(lastLine); | |
redrawStopX = getXAtOffset(line, lastLine, offsetInLastLine); | |
redrawY = lastLine * lineHeight - verticalScrollOffset; | |
draw(0, redrawY, redrawStopX, lineHeight, gc, clearBackground); | |
} | |
lastLine--; // last line has been redrawn. | |
} | |
// redraw entire center lines if redraw range includes more than two lines | |
if (lastLine >= firstLine) { | |
int redrawStopY = (lastLine + 1) * lineHeight - verticalScrollOffset; | |
redrawY = firstLine * lineHeight - verticalScrollOffset; | |
draw(0, redrawY, clientArea.width, redrawStopY - redrawY, gc, clearBackground); | |
} | |
if (gc != null) { | |
gc.dispose(); | |
} | |
} | |
/** | |
* Fixes the widget to display a text change. | |
* Bit blitting and redrawing is done as necessary. | |
* <p> | |
* | |
* @param x x location of the text change | |
* @param y y location of the text change | |
* @param newLineCount number of new lines. | |
* @param replacedLineCount number of replaced lines. | |
*/ | |
void redrawMultiLineChange(int x, int y, int newLineCount, int replacedLineCount) { | |
Rectangle clientArea = getClientArea(); | |
int lineHeight = getLineHeight(); | |
int lineCount = newLineCount - replacedLineCount; | |
int sourceY; | |
int destinationY; | |
if (lineCount > 0) { | |
sourceY = Math.max(0, y + lineHeight); | |
destinationY = sourceY + lineCount * lineHeight; | |
} | |
else { | |
destinationY = Math.max(0, y + lineHeight); | |
sourceY = destinationY - lineCount * lineHeight; | |
} | |
scroll( | |
0, destinationY, // destination x, y | |
0, sourceY, // source x, y | |
clientArea.width, clientArea.height, true); | |
// Always redrawing causes the bottom line to flash when a line is | |
// deleted. This is because SWT merges the paint area of the scroll | |
// with the paint area of the redraw call below. | |
// To prevent this we could call update after the scroll. However, | |
// adding update can cause even more flash if the client does other | |
// redraw/update calls (ie. for syntax highlighting). | |
// We could also redraw only when a line has been added or when | |
// contents has been added to a line. This would require getting | |
// line index info from the content and is not worth the trouble | |
// (the flash is only on the bottom line and minor). | |
// Specifying the NO_MERGE_PAINTS style bit prevents the merged | |
// redraw but could cause flash/slowness elsewhere. | |
if (y + lineHeight > 0 && y <= clientArea.height) { | |
// redraw first changed line in case a line was split/joined | |
redraw(x, y, clientArea.width, lineHeight, true); | |
} | |
if (newLineCount > 0) { | |
int redrawStartY = y + lineHeight; | |
int redrawHeight = newLineCount * lineHeight; | |
if (redrawStartY + redrawHeight > 0 && redrawStartY <= clientArea.height) { | |
// display new text | |
redraw(0, redrawStartY, clientArea.width, redrawHeight, true); | |
} | |
} | |
} | |
/** | |
* Fixes the widget after a text change local to one line ocurred. | |
* Bit blitting and/or redrawing is done as necessary. | |
* <p> | |
* | |
* @param textChangeX x location of the text change | |
* @param textChangeY y location of the text change | |
* @param newCharCount number of new characters | |
* @param replacedCharCount number of replaced characters | |
* @param textChangeStopX the x location of the character after last | |
* changed character | |
*/ | |
void redrawSingleLineChange(int textChangeX, int textChangeY, int newCharCount, int replacedCharCount, int textChangeStopX) { | |
Rectangle clientArea = getClientArea(); | |
int lineHeight = getLineHeight(); | |
if (newCharCount == 0) { | |
// characters were deleted | |
scroll( | |
textChangeX, textChangeY, // destination x, y | |
textChangeStopX, textChangeY, // source x, y | |
clientArea.width, lineHeight, true); | |
} | |
else | |
if (replacedCharCount == 0) { | |
// characters were added | |
scroll( | |
textChangeStopX, textChangeY, // destination x, y | |
textChangeX, textChangeY, // source x, y | |
clientArea.width, lineHeight, true); | |
} | |
else { | |
// simple redraw if text has been replaced with other text | |
redraw(textChangeX, textChangeY, clientArea.width, lineHeight, true); | |
} | |
} | |
/** | |
* Fixes the widget after a text change local to one line ocurred. | |
* The line has a tab after the text change offset. Bit blitting | |
* and/or redrawing is done as necessary. | |
* <p> | |
* | |
* @param textChangeX x location of the text change | |
* @param textChangeY y location of the text change | |
* @param newTabX the x location of the tab closest to the insert | |
* location as measured with the text change. | |
* @param oldTabX the x location of the tab closest to the insert | |
* location as measured without the text change. | |
*/ | |
void redrawSingleLineTabChange(int textChangeX, int textChangeY, int newTabX, int oldTabX) { | |
Rectangle clientArea = getClientArea(); | |
int lineHeight = getLineHeight(); | |
if (newTabX > oldTabX) { | |
scroll( | |
newTabX, textChangeY, // destination x, y | |
oldTabX, textChangeY, // source x, y | |
clientArea.width, lineHeight, true); | |
redraw(textChangeX, textChangeY, oldTabX - textChangeX, lineHeight, true); | |
} | |
else | |
if (newTabX < oldTabX) { | |
scroll( | |
newTabX, textChangeY, // destination x, y | |
oldTabX, textChangeY, // source x, y | |
clientArea.width, lineHeight, true); | |
redraw(textChangeX, textChangeY, newTabX - textChangeX, lineHeight, true); | |
} | |
else { | |
// tab location unchanged. redraw text between change offset and tab | |
redraw(textChangeX, textChangeY, newTabX - textChangeX, lineHeight, true); | |
} | |
} | |
/** | |
* Removes the specified extended modify listener. | |
* <p> | |
* | |
* @param listener the listener | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_NULL_ARGUMENT when listener is null</li> | |
* </ul> | |
*/ | |
public void removeExtendedModifyListener(ExtendedModifyListener extendedModifyListener) { | |
checkWidget(); | |
if (extendedModifyListener == null) SWT.error(SWT.ERROR_NULL_ARGUMENT); | |
removeListener(ExtendedModify, extendedModifyListener); | |
} | |
/** | |
* Removes the specified line background listener. | |
* <p> | |
* | |
* @param listener the listener | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_NULL_ARGUMENT when listener is null</li> | |
* </ul> | |
*/ | |
public void removeLineBackgroundListener(LineBackgroundListener listener) { | |
checkWidget(); | |
if (listener == null) SWT.error(SWT.ERROR_NULL_ARGUMENT); | |
removeListener(LineGetBackground, listener); | |
// use default line styler if last user line styler was removed. | |
if (isListening(LineGetBackground) == false && userLineBackground) { | |
StyledTextListener typedListener = new StyledTextListener(defaultLineStyler); | |
addListener(LineGetBackground, typedListener); | |
userLineBackground = false; | |
} | |
} | |
/** | |
* Removes the specified line style listener. | |
* <p> | |
* | |
* @param listener the listener | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_NULL_ARGUMENT when listener is null</li> | |
* </ul> | |
*/ | |
public void removeLineStyleListener(LineStyleListener listener) { | |
checkWidget(); | |
if (listener == null) { | |
SWT.error(SWT.ERROR_NULL_ARGUMENT); | |
} | |
removeListener(LineGetStyle, listener); | |
// use default line styler if last user line styler was removed. Fixes 1G7B1X2 | |
if (isListening(LineGetStyle) == false && userLineStyle) { | |
StyledTextListener typedListener = new StyledTextListener(defaultLineStyler); | |
addListener(LineGetStyle, typedListener); | |
userLineStyle = false; | |
} | |
} | |
/** | |
* Removes the specified modify listener. | |
* <p> | |
* | |
* @param listener the listener | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_NULL_ARGUMENT when listener is null</li> | |
* </ul> | |
*/ | |
public void removeModifyListener(ModifyListener modifyListener) { | |
checkWidget(); | |
if (modifyListener == null) { | |
SWT.error(SWT.ERROR_NULL_ARGUMENT); | |
} | |
removeListener(SWT.Modify, modifyListener); | |
} | |
/** | |
* Removes the specified selection listener. | |
* <p> | |
* | |
* @param listener the listener | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_NULL_ARGUMENT when listener is null</li> | |
* </ul> | |
*/ | |
public void removeSelectionListener(SelectionListener listener) { | |
checkWidget(); | |
if (listener == null) { | |
SWT.error(SWT.ERROR_NULL_ARGUMENT); | |
} | |
removeListener(SWT.Selection, listener); | |
} | |
/** | |
* Removes the specified verify listener. | |
* <p> | |
* | |
* @param listener the listener | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_NULL_ARGUMENT when listener is null</li> | |
* </ul> | |
*/ | |
public void removeVerifyListener(VerifyListener verifyListener) { | |
checkWidget(); | |
if (verifyListener == null) { | |
SWT.error(SWT.ERROR_NULL_ARGUMENT); | |
} | |
removeListener(SWT.Verify, verifyListener); | |
} | |
/** | |
* Removes the specified key verify listener. | |
* <p> | |
* | |
* @param listener the listener | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_NULL_ARGUMENT when listener is null</li> | |
* </ul> | |
*/ | |
public void removeVerifyKeyListener(VerifyKeyListener listener) { | |
if (listener == null) SWT.error(SWT.ERROR_NULL_ARGUMENT); | |
removeListener(VerifyKey, listener); | |
} | |
/** | |
* Replaces the given text range with new text. | |
* If the widget has the SWT.SINGLE style and "text" contains more than | |
* one line, only the first line is rendered but the text is stored | |
* unchanged. A subsequent call to getText will return the same text | |
* that was set. Note that only a single line of text should be set when | |
* the SWT.SINGLE style is used. | |
* <p> | |
* <b>NOTE:</b> During the replace operation the current selection is changed | |
* as follows: | |
* <ul> | |
* <li>selection before replaced text: selection unchanged | |
* <li>selection after replaced text: adjust the selection so that same text | |
* remains selected | |
* <li>selection intersects replaced text: selection is cleared and caret is placed | |
* after inserted text | |
* </ul> | |
* </p> | |
* | |
* @param start offset of first character to replace | |
* @param length number of characters to replace. Use 0 to insert text | |
* @param text new text. May be empty to delete text. | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_INVALID_RANGE when either start or end is outside the valid range (0 <= offset <= getCharCount())</li> | |
* </ul> | |
*/ | |
public void replaceTextRange(int start, int length, String text) { | |
checkWidget(); | |
int contentLength = getCharCount(); | |
int end = start + length; | |
Event event = new Event(); | |
if (start < 0 || start > contentLength || end < 0 || end > contentLength || start > end) { | |
SWT.error(SWT.ERROR_INVALID_RANGE); | |
} | |
event.start = start; | |
event.end = end; | |
event.text = text; | |
modifyContent(event, false); | |
} | |
/** | |
* Resets the caret position, selection and scroll offsets. Recalculate | |
* the content width and scroll bars. Redraw the widget. | |
*/ | |
void reset() { | |
ScrollBar verticalBar = getVerticalBar(); | |
ScrollBar horizontalBar = getHorizontalBar(); | |
caretOffset = 0; | |
topIndex = 0; | |
verticalScrollOffset = 0; | |
horizontalScrollOffset = 0; | |
contentWidth = 0; | |
contentWidthIndex = 0; | |
resetSelection(); | |
// discard any styles that may have been set by creating a | |
// new default line styler | |
if (defaultLineStyler != null) { | |
removeLineBackgroundListener(defaultLineStyler); | |
removeLineStyleListener(defaultLineStyler); | |
installDefaultLineStyler(); | |
} | |
calculateContentWidth(); | |
if (verticalBar != null) { | |
verticalBar.setSelection(0); | |
} | |
if (horizontalBar != null) { | |
horizontalBar.setSelection(0); | |
} | |
setScrollBars(); | |
setCaretLocation(); | |
redraw(); | |
} | |
/** | |
* Resets the selection. | |
*/ | |
void resetSelection() { | |
selection.x = selection.y = caretOffset; | |
selectionAnchor = -1; | |
} | |
/** | |
* Scrolls the widget horizontally. | |
* <p> | |
* | |
* @param pixels number of pixels to scroll, > 0 = scroll left, < 0 scroll right | |
*/ | |
void scrollHorizontal(int pixels) { | |
Rectangle clientArea; | |
if (pixels == 0) { | |
return; | |
} | |
clientArea = getClientArea(); | |
scroll( | |
pixels * -1, 0, // destination x, y | |
0, 0, // source x, y | |
clientArea.width, clientArea.height, true); | |
horizontalScrollOffset += pixels; | |
setCaretLocation(); | |
} | |
/** | |
* Scrolls the widget horizontally and adjust the horizontal scroll bar to | |
* reflect the new horizontal offset.. | |
* <p> | |
* | |
* @param pixels number of pixels to scroll, > 0 = scroll left, < 0 scroll right | |
*/ | |
void scrollHorizontalBar(int pixels) { | |
if (pixels == 0) { | |
return; | |
} | |
ScrollBar horizontalBar = getHorizontalBar(); | |
if (horizontalBar != null) { | |
horizontalBar.setSelection(horizontalScrollOffset + pixels); | |
} | |
scrollHorizontal(pixels); | |
} | |
/** | |
* Selects all the text. | |
* <p> | |
* | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public void selectAll() { | |
checkWidget(); | |
setSelection(new Point(0, Math.max(getCharCount(),0))); | |
} | |
/** | |
* Replaces/inserts text as defined by the event. | |
* <p> | |
* | |
* @param event the text change event. | |
* <ul> | |
* <li>event.start - the replace start offset</li> | |
* <li>event.end - the replace end offset</li> | |
* <li>event.text - the new text</li> | |
* </ul> | |
*/ | |
void sendKeyEvent(Event event) { | |
if (editable == false) { | |
return; | |
} | |
modifyContent(event, true); | |
} | |
/** | |
* Sends the specified selection event. | |
*/ | |
void sendSelectionEvent() { | |
Event event = new Event(); | |
event.x = selection.x; | |
event.y = selection.y; | |
notifyListeners(SWT.Selection, event); | |
} | |
/** | |
* Moves the Caret to the current caret offset. | |
*/ | |
void setCaretLocation() { | |
int line = content.getLineAtOffset(caretOffset); | |
int lineStartOffset = content.getOffsetAtLine(line); | |
int lineX = getXAtOffset(content.getLine(line), line, caretOffset - lineStartOffset); | |
int lineHeight = getLineHeight(); | |
caret.setLocation(lineX, line * lineHeight - verticalScrollOffset); | |
} | |
/** | |
* Sets the caret offset. | |
* <p> | |
* <b>NOTE:</b> If offset is greater than the number of characters of text in the | |
* widget, the value will be ignored. | |
* </p> | |
* | |
* @param offset caret offset, relative to the first character in the text. | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public void setCaretOffset(int offset) { | |
checkWidget(); | |
int length = getCharCount(); | |
if (length > 0 && offset != caretOffset) { | |
if (offset < 0) { | |
caretOffset = 0; | |
} | |
else | |
if (offset > length) { | |
caretOffset = length; | |
} | |
else { | |
caretOffset = offset; | |
} | |
// clear the selection if the caret is moved. | |
// don't notify listeners about the selection change. | |
clearSelection(false); | |
} | |
// always update the caret location. fixes 1G8FODP | |
setCaretLocation(); | |
} | |
/** | |
* Sets the content implementation to use for text storage. | |
* <p> | |
* | |
* @param content StyledTextContent implementation to use for text storage. | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_NULL_ARGUMENT when listener is null</li> | |
* </ul> | |
*/ | |
public void setContent(StyledTextContent content) { | |
checkWidget(); | |
if (content == null) { | |
SWT.error(SWT.ERROR_NULL_ARGUMENT); | |
} | |
if (this.content != null) { | |
this.content.removeTextChangeListener(textChangeListener); | |
} | |
this.content = content; | |
content.addTextChangeListener(textChangeListener); | |
reset(); | |
} | |
/** | |
* Sets whether the widget implements double click mouse behavior. | |
* </p> | |
* | |
* @param enable if true double clicking a word selects the word, if false | |
* double clicks have the same effect as regular mouse clicks. | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public void setDoubleClickEnabled(boolean enable) { | |
checkWidget(); | |
doubleClickEnabled = enable; | |
} | |
/** | |
* Sets whether the widget content can be edited. | |
* </p> | |
* | |
* @param editable if true content can be edited, if false content can not be | |
* edited | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public void setEditable(boolean editable) { | |
checkWidget(); | |
this.editable = editable; | |
} | |
/** | |
* Sets a new font to render text with. | |
* <p> | |
* <b>NOTE:</b> Italic fonts are not supported unless they have no overhang | |
* and the same baseline as regular fonts. | |
* </p> | |
* | |
* @param font new font | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public void setFont(Font font) { | |
checkWidget(); | |
super.setFont(font); | |
if (boldFont != null) { | |
boldFont.dispose(); | |
} | |
initializeFonts(); | |
lineHeight = 0; | |
contentWidth = 0; | |
contentWidthIndex = 0; | |
setTabs(getTabs()); | |
calculateContentWidth(); | |
calculateScrollBars(); | |
setTabs(tabLength); | |
caret.setSize(0, getLineHeight()); | |
redraw(); | |
} | |
/** | |
* Sets the horizontal scroll offset relative to the start of the line. | |
* Do nothing if there is no text set. | |
* <p> | |
* <b>NOTE:</b> The horizontal index is reset to 0 when new text is set in the | |
* widget. | |
* </p> | |
* | |
* @param offset horizontal scroll offset relative to the start | |
* of the line, measured in character increments starting at 0, if | |
* equal to 0 the content is not scrolled, if > 0 = the content is scrolled. | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public void setHorizontalIndex(int offset) { | |
checkWidget(); | |
int clientAreaWidth = getClientArea().width; | |
if (getCharCount() == 0) { | |
return; | |
} | |
if (offset < 0) { | |
offset = 0; | |
} | |
offset *= getHorizontalIncrement(); | |
// allow any value if client area width is unknown or 0. | |
// offset will be checked in resize handler. | |
// don't use isVisible since width is known even if widget | |
// is temporarily invisible | |
if (clientAreaWidth > 0) { | |
// prevent scrolling if the content fits in the client area. | |
// align end of longest line with right border of client area | |
// if offset is out of range. | |
if (offset > contentWidth - clientAreaWidth) { | |
offset = Math.max(0, contentWidth - clientAreaWidth); | |
} | |
} | |
scrollHorizontalBar(offset - horizontalScrollOffset); | |
} | |
/** | |
* Sets the background color of the specified lines. | |
* The background color is drawn for the width of the widget. All | |
* line background colors are discarded when setText is called. | |
* The text background color if defined in a StyleRange overlays the | |
* line background color. Should not be called if a LineBackgroundListener | |
* has been set since the listener maintains the line backgrounds. | |
* <p> | |
* During text changes, when entire lines are inserted or removed, the line | |
* background colors that are associated with the lines after the change | |
* will "move" with their respective text. For all other text changes, | |
* line background colors will remain unchanged. | |
* </p> | |
* | |
* @param startLine first line the color is applied to, 0 based | |
* @param lineCount number of lines the color applies to. | |
* @param background line background color | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_INVALID_ARGUMENT when the specified line range is invalid</li> | |
* </ul> | |
*/ | |
public void setLineBackground(int startLine, int lineCount, Color background) { | |
checkWidget(); | |
int partialBottomIndex = getPartialBottomIndex(); | |
int lineHeight = getLineHeight(); | |
// this API can not be used if the client is providing the line background | |
if (userLineBackground) { | |
return; | |
} | |
if (startLine < 0 || startLine + lineCount > content.getLineCount()) { | |
SWT.error(SWT.ERROR_INVALID_ARGUMENT); | |
} | |
defaultLineStyler.setLineBackground(startLine, lineCount, background); | |
// do nothing if redraw range is completely invisible | |
if (startLine > partialBottomIndex || startLine + lineCount - 1 < topIndex) { | |
return; | |
} | |
// only redraw visible lines | |
if (startLine < topIndex) { | |
lineCount -= topIndex - startLine; | |
startLine = topIndex; | |
} | |
if (startLine + lineCount - 1 > partialBottomIndex) { | |
lineCount = partialBottomIndex - startLine + 1; | |
} | |
startLine -= topIndex; | |
redraw( | |
0, startLine * lineHeight, | |
getClientArea().width, lineCount * lineHeight, true); | |
} | |
/** | |
* Sets the background of the specified GC for a line rendering operation, | |
* if it is not already set. | |
* </p> | |
* | |
* @param gc GC to set the background color in | |
* @param currentBackground background color currently set in gc | |
* @param newBackground new background color of gc | |
*/ | |
Color setLineBackground(GC gc, Color currentBackground, Color newBackground) { | |
if (currentBackground.equals(newBackground) == false) { | |
gc.setBackground(newBackground); | |
} | |
return newBackground; | |
} | |
/** | |
* Sets the font of the specified GC if it is not already set. | |
* </p> | |
* | |
* @param gc GC to set the font in | |
* @param currentFont font data of font currently set in gc | |
* @param style desired style of the font in gc. Can be one of | |
* SWT.NORMAL, SWT.ITALIC, SWT.BOLD | |
* @return the font data of the font set in "gc". Same as "currentFont" if | |
* currentFont.getStyle() == "style". | |
*/ | |
FontData setLineFont(GC gc, FontData currentFont, int style) { | |
if (currentFont.getStyle() != style) { | |
if (style == SWT.BOLD) { | |
currentFont.setStyle(style); | |
gc.setFont(boldFont); | |
} | |
else | |
if (style == SWT.NORMAL) { | |
currentFont.setStyle(style); | |
gc.setFont(regularFont); | |
} | |
} | |
return currentFont; | |
} | |
/** | |
* Sets the foreground of the specified GC for a line rendering operation, | |
* if it is not already set. | |
* </p> | |
* | |
* @param gc GC to set the foreground color in | |
* @param currentForeground foreground color currently set in gc | |
* @param newForeground new foreground color of gc | |
*/ | |
Color setLineForeground(GC gc, Color currentForeground, Color newForeground) { | |
if (currentForeground.equals(newForeground) == false) { | |
gc.setForeground(newForeground); | |
} | |
return newForeground; | |
} | |
/** | |
* Adjusts the scroll bar maximum and page size to reflect content | |
* width/length changes. | |
*/ | |
void setScrollBars() { | |
ScrollBar verticalBar = getVerticalBar(); | |
ScrollBar horizontalBar = getHorizontalBar(); | |
Rectangle clientArea = getClientArea(); | |
final int INACTIVE = 1; | |
if (verticalBar != null) { | |
int maximum = content.getLineCount() * getVerticalIncrement(); | |
// only set the real values if the scroll bar can be used | |
// (ie. because the thumb size is less than the scroll maximum) | |
// avoids flashing on Motif, fixes 1G7RE1J and 1G5SE92 | |
if (clientArea.height < maximum) { | |
verticalBar.setValues( | |
verticalBar.getSelection(), | |
verticalBar.getMinimum(), | |
maximum, | |
clientArea.height, // thumb size | |
verticalBar.getIncrement(), | |
clientArea.height); // page size | |
} | |
else | |
if (verticalBar.getThumb() != INACTIVE || verticalBar.getMaximum() != INACTIVE) { | |
verticalBar.setValues( | |
verticalBar.getSelection(), | |
verticalBar.getMinimum(), | |
INACTIVE, | |
INACTIVE, | |
verticalBar.getIncrement(), | |
INACTIVE); | |
} | |
} | |
if (horizontalBar != null) { | |
// only set the real values if the scroll bar can be used | |
// (ie. because the thumb size is less than the scroll maximum) | |
// avoids flashing on Motif, fixes 1G7RE1J and 1G5SE92 | |
if (clientArea.width < contentWidth) { | |
horizontalBar.setValues( | |
horizontalBar.getSelection(), | |
horizontalBar.getMinimum(), | |
contentWidth, // maximum | |
clientArea.width, // thumb size | |
horizontalBar.getIncrement(), | |
clientArea.width); // page size | |
} | |
else | |
if (horizontalBar.getThumb() != INACTIVE || horizontalBar.getMaximum() != INACTIVE) { | |
horizontalBar.setValues( | |
horizontalBar.getSelection(), | |
horizontalBar.getMinimum(), | |
INACTIVE, | |
INACTIVE, | |
horizontalBar.getIncrement(), | |
INACTIVE); | |
} | |
} | |
} | |
/** | |
* Sets the selection to the given position and scrolls it into view. Equivalent to setSelection(start,start). | |
* <p> | |
* | |
* @param start new caret position | |
* @see #setSelection(int,int) | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_INVALID_RANGE when start is outside the widget content | |
* </ul> | |
*/ | |
public void setSelection(int start) { | |
setSelection(start, start); | |
} | |
/** | |
* Sets the selection and scrolls it into view. | |
* <p> | |
* Indexing is zero based. Text selections are specified in terms of | |
* caret positions. In a text widget that contains N characters, there are | |
* N+1 caret positions, ranging from 0..N | |
* </p> | |
* | |
* @param point x=selection start offset, y=selection end offset | |
* @see #setSelection(int,int) | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_NULL_ARGUMENT when point is null</li> | |
* <li>ERROR_INVALID_RANGE when start and end is outside the widget content | |
* </ul> | |
*/ | |
public void setSelection(Point point) { | |
checkWidget(); | |
if (point == null) SWT.error (SWT.ERROR_NULL_ARGUMENT); | |
setSelection(point.x, point.y); | |
} | |
/** | |
* Sets the selection and scrolls it into view. | |
* <p> | |
* Indexing is zero based. Text selections are specified in terms of | |
* caret positions. In a text widget that contains N characters, there are | |
* N+1 caret positions, ranging from 0..N | |
* </p> | |
* | |
* @param start selection start offset | |
* @param end selection end offset | |
* @see #setSelectionRange(int,int) | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_INVALID_RANGE when start and end is outside the widget content | |
* </ul> | |
*/ | |
public void setSelection(int start, int end) { | |
checkWidget(); | |
int contentLength = getCharCount(); | |
if (start > end || start < 0 || end > contentLength) { | |
SWT.error(SWT.ERROR_INVALID_RANGE); | |
} | |
internalSetSelection(start, end - start); | |
// always update the caret location. fixes 1G8FODP | |
setCaretLocation(); | |
showSelection(); | |
} | |
/** | |
* Sets the selection. The new selection may not be visible. Call showSelection to scroll | |
* the selection into view. | |
* <p> | |
* | |
* @param start offset of the first selected character, start >= 0 must be true. | |
* @param length number of characters to select, start <= start + length <= getCharCount() | |
* must be true. | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_INVALID_RANGE when the range specified by start and length is outside the widget content | |
* </ul> | |
*/ | |
public void setSelectionRange(int start, int length) { | |
checkWidget(); | |
int contentLength = getCharCount(); | |
int end = start + length; | |
if (start > end || start < 0 || end > contentLength) { | |
SWT.error(SWT.ERROR_INVALID_RANGE); | |
} | |
internalSetSelection(start, length); | |
// always update the caret location. fixes 1G8FODP | |
setCaretLocation(); | |
} | |
/** | |
* Sets the selection. | |
* The new selection may not be visible. Call showSelection to scroll | |
* the selection into view. | |
* <p> | |
* | |
* @param start offset of the first selected character, start >= 0 must be true. | |
* @param length number of characters to select, start <= start + length | |
* <= getCharCount() must be true. | |
*/ | |
void internalSetSelection(int start, int length) { | |
int end = start + length; | |
if (selection.x != start || selection.y != end) { | |
clearSelection(false); | |
selectionAnchor = selection.x = start; | |
caretOffset = selection.y = end; | |
if (length > 0) { | |
redrawRange(selection.x, selection.y - selection.x, true); | |
} | |
} | |
} | |
/** | |
* Adds the specified style. The new style overwrites existing styles for the | |
* specified range. Existing style ranges are adjusted if they partially | |
* overlap with the new style, To clear an individual style, call setStyleRange | |
* with a StyleRange that has null attributes. | |
* <p> | |
* Should not be called if a LineStyleListener has been set since the | |
* listener maintains the styles. | |
* </p> | |
* | |
* @param range StyleRange object containing the style information. | |
* Overwrites the old style in the given range. May be null to delete | |
* all styles. | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_INVALID_RANGE when the style range is outside the valid range (> getCharCount())</li> | |
* </ul> | |
*/ | |
public void setStyleRange(StyleRange range) { | |
checkWidget(); | |
boolean redrawFirstLine = false; | |
boolean redrawLastLine = false; | |
// this API can not be used if the client is providing the line styles | |
if (userLineStyle) { | |
return; | |
} | |
// check the range, make sure it falls within the range of the | |
// text | |
if (range != null && range.start + range.length > content.getCharCount()) { | |
SWT.error(SWT.ERROR_INVALID_RANGE); | |
} | |
if (range != null) { | |
// the first and last line needs to be redrawn completely if the | |
// font style is changing from SWT.NORMAL to something else or | |
// vice versa. fixes 1G7M5WE. | |
int rangeEnd = range.start + range.length; | |
int firstLine = content.getLineAtOffset(range.start); | |
int lastLine = content.getLineAtOffset(rangeEnd); | |
int firstLineOffset = content.getOffsetAtLine(firstLine); | |
if (isStyleChanging(range, range.start, Math.min(rangeEnd, firstLineOffset + content.getLine(firstLine).length()))) { | |
redrawFirstLine = true; | |
} | |
if (lastLine != firstLine) { | |
int lastLineOffset = content.getOffsetAtLine(lastLine); | |
if (isStyleChanging(range, lastLineOffset, rangeEnd)) { | |
redrawLastLine = true; | |
} | |
} | |
} | |
defaultLineStyler.setStyleRange(range); | |
if (range != null) { | |
int lineHeight = getLineHeight(); | |
redrawRange(range.start, range.length, true); | |
if (redrawFirstLine) { | |
// redraw starting at the style change start offset since | |
// single line text changes, followed by style changes will | |
// flash otherwise | |
int firstLine = content.getLineAtOffset(range.start); | |
int firstLineOffset = content.getOffsetAtLine(firstLine); | |
String firstLineText = content.getLine(firstLine); | |
int redrawX = getXAtOffset(firstLineText, firstLine, range.start - firstLineOffset); | |
int redrawY = firstLine * lineHeight - verticalScrollOffset; | |
redraw(redrawX, redrawY, getClientArea().width, lineHeight, true); | |
} | |
if (redrawLastLine) { | |
// redraw the whole line if the font style changed on the last line | |
int lastLine = content.getLineAtOffset(range.start + range.length); | |
int redrawY = lastLine * lineHeight - verticalScrollOffset; | |
redraw(0, redrawY, getClientArea().width, lineHeight, true); | |
} | |
} | |
else { | |
redraw(); | |
} | |
// make sure that the caret is positioned correctly. | |
// caret location may change if font style changes. | |
// fixes 1G8FODP | |
setCaretLocation(); | |
} | |
/** | |
* Sets styles to be used for rendering the widget content. All styles | |
* will be replaced with the given set of styles. | |
* <p> | |
* Should not be called if a LineStyleListener has been set since the | |
* listener maintains the styles. | |
* </p> | |
* | |
* @param ranges StyleRange objects containing the style information. | |
* The ranges should not overlap. The style rendering is undefined if | |
* the ranges do overlap. Must not be null. | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_NULL_ARGUMENT when listener is null</li> | |
* <li>ERROR_INVALID_RANGE when the last of the style ranges is outside the valid range (> getCharCount())</li> | |
* </ul> | |
*/ | |
public void setStyleRanges(StyleRange[] ranges) { | |
checkWidget(); | |
// this API can not be used if the client is providing the line styles | |
if (userLineStyle) { | |
return; | |
} | |
if (ranges == null) { | |
SWT.error(SWT.ERROR_NULL_ARGUMENT); | |
} | |
// check the last range, make sure it falls within the range of the | |
// current text | |
if (ranges.length != 0) { | |
StyleRange last = ranges[ranges.length-1]; | |
if (last.start + last.length > content.getCharCount()) { | |
SWT.error(SWT.ERROR_INVALID_RANGE); | |
} | |
} | |
defaultLineStyler.setStyleRanges(ranges); | |
redraw(); // should only redraw affected area to avoid flashing | |
// make sure that the caret is positioned correctly. | |
// caret location may change if font style changes. | |
// fixes 1G8FODP | |
setCaretLocation(); | |
} | |
/** | |
* Sets the tab width. | |
* <p> | |
* | |
* @param tabs tab width measured in characters. | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public void setTabs(int tabs) { | |
checkWidget(); | |
tabLength = tabs; | |
calculateTabWidth(); | |
if (caretOffset > 0) { | |
caretOffset = 0; | |
showCaret(); | |
clearSelection(false); | |
} | |
redraw(); | |
} | |
/** | |
* Sets the widget content. | |
* If the widget has the SWT.SINGLE style and "text" contains more than | |
* one line, only the first line is rendered but the text is stored | |
* unchanged. A subsequent call to getText will return the same text | |
* that was set. | |
* <p> | |
* <b>Note:</b> Only a single line of text should be set when the SWT.SINGLE | |
* style is used. | |
* </p> | |
* | |
* @param text new widget content. Replaces existing content. Line styles | |
* that were set using StyledText API are discarded. The | |
* current selection is also discarded. | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public void setText(String text) { | |
checkWidget(); | |
Event event = new Event(); | |
event.start = 0; | |
event.end = getCharCount(); | |
event.text = text; | |
event.doit = true; | |
notifyListeners(SWT.Verify, event); | |
if (event.doit) { | |
String replacedText = content.getTextRange(event.start, event.end - event.start); | |
content.setText(event.text); | |
event.end = event.start + event.text.length(); | |
event.text = replacedText; | |
notifyListeners(SWT.Modify, event); | |
} | |
} | |
/** | |
* Sets the text limit. | |
* <p> | |
* The text limit specifies the amount of text that | |
* the user can type into the widget. | |
* </p> | |
* | |
* @param limit the new text limit. | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
* @exception IllegalArgumentException <ul> | |
* <li>ERROR_CANNOT_BE_ZERO when limit is 0</li> | |
* </ul> | |
*/ | |
public void setTextLimit(int limit) { | |
checkWidget(); | |
if (limit == 0) { | |
SWT.error(SWT.ERROR_CANNOT_BE_ZERO); | |
} | |
textLimit = limit; | |
} | |
/** | |
* Sets the top index. Do nothing if there is no text set. | |
* <p> | |
* The top index is the index of the line that is currently at the top | |
* of the widget. The top index changes when the widget is scrolled. | |
* Indexing starts from zero. | |
* Note: The top index is reset to 0 when new text is set in the widget. | |
* </p> | |
* | |
* @param index new top index. Must be between 0 and getLineCount() - | |
* visible lines per page. An out of range index will be adjusted accordingly. | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public void setTopIndex(int topIndex) { | |
checkWidget(); | |
int lineCount = content.getLineCount(); | |
int pageSize = Math.min(lineCount, getLineCountWhole()); | |
if (getCharCount() == 0) { | |
return; | |
} | |
if (topIndex < 0) { | |
topIndex = 0; | |
} | |
else | |
if (topIndex > lineCount - pageSize) { | |
topIndex = lineCount - pageSize; | |
} | |
setVerticalScrollOffset(topIndex * getVerticalIncrement(), true); | |
// set the top index directly in case setVerticalScrollOffset didn't | |
// (ie. because the widget is not yet visible) | |
this.topIndex = topIndex; | |
} | |
/** | |
* Scrolls the widget vertically. | |
* <p> | |
* | |
* @param pixels number of pixels to scroll. > 0 = scroll up, < 0 scroll down | |
*/ | |
void setVerticalScrollOffset(int pixelOffset, boolean adjustScrollBar) { | |
Rectangle clientArea; | |
ScrollBar verticalBar = getVerticalBar(); | |
int verticalIncrement = getVerticalIncrement(); | |
if (pixelOffset == verticalScrollOffset) { | |
return; | |
} | |
if (verticalBar != null && adjustScrollBar) { | |
verticalBar.setSelection(pixelOffset); | |
} | |
clientArea = getClientArea(); | |
scroll( | |
0, 0, // destination x, y | |
0, pixelOffset - verticalScrollOffset, // source x, y | |
clientArea.width, clientArea.height, true); | |
if (verticalIncrement != 0) { | |
int oldTopIndex = topIndex; | |
topIndex = (int) Math.ceil((float) pixelOffset / verticalIncrement); | |
if (topIndex != oldTopIndex) { | |
int lineCount = content.getLineCount(); | |
int visibleItemCount = (int) Math.ceil((float) clientArea.height / verticalIncrement); | |
int oldBottomIndex = Math.min(oldTopIndex + visibleItemCount, lineCount); | |
int newItemCount = topIndex - oldTopIndex; | |
if (Math.abs(newItemCount) > visibleItemCount) { | |
calculateContentWidth(); | |
} | |
else { | |
if (newItemCount > 0) { | |
newItemCount = Math.min(newItemCount, lineCount - oldBottomIndex); | |
calculateContentWidth(oldBottomIndex, newItemCount); | |
} | |
else | |
if (newItemCount < 0) { | |
// make sure calculation range does not exceed number of lines | |
// fixes 1GBKCLF | |
calculateContentWidth(topIndex, Math.min(newItemCount * -1, lineCount - topIndex)); | |
} | |
} | |
setScrollBars(); | |
} | |
} | |
verticalScrollOffset = pixelOffset; | |
setCaretLocation(); | |
} | |
/** | |
* Sets the caret location and scrolls the caret offset into view. | |
*/ | |
void showCaret() { | |
int line = content.getLineAtOffset(caretOffset); | |
int lineOffset = content.getOffsetAtLine(line); | |
int offsetInLine = caretOffset - lineOffset; | |
String lineText = content.getLine(line); | |
int xAtOffset = getXAtOffset(lineText, line, offsetInLine); | |
int clientAreaWidth = getClientArea().width; | |
int verticalIncrement = getVerticalIncrement(); | |
int horizontalIncrement = clientAreaWidth / 4; | |
boolean scrolled = false; | |
if (xAtOffset < 0) { | |
// always make 1/4 of a page visible | |
xAtOffset = Math.max(horizontalScrollOffset * -1, xAtOffset - horizontalIncrement); | |
scrollHorizontalBar(xAtOffset); | |
scrolled = true; | |
} | |
else | |
if (xAtOffset > clientAreaWidth) { | |
// always make 1/4 of a page visible | |
xAtOffset = Math.min(contentWidth - horizontalScrollOffset, xAtOffset + horizontalIncrement); | |
scrollHorizontalBar(xAtOffset - clientAreaWidth); | |
scrolled = true; | |
} | |
if (line < topIndex) { | |
setVerticalScrollOffset(line * verticalIncrement, true); | |
scrolled = true; | |
} | |
else | |
if (line > getBottomIndex()) { | |
setVerticalScrollOffset((line - getBottomIndex()) * verticalIncrement + verticalScrollOffset, true); | |
scrolled = true; | |
} | |
if (scrolled == false) { | |
caret.setLocation(xAtOffset, line * getLineHeight() - verticalScrollOffset); | |
} | |
} | |
/** | |
* Scrolls the specified offset into view. | |
* <p> | |
* | |
* @param offset offset that should be scolled into view | |
*/ | |
void showOffset(int offset) { | |
int line = content.getLineAtOffset(offset); | |
int lineOffset = content.getOffsetAtLine(line); | |
int offsetInLine = offset - lineOffset; | |
String lineText = content.getLine(line); | |
int xAtOffset = getXAtOffset(lineText, line, offsetInLine); | |
int clientAreaWidth = getClientArea().width; | |
int verticalIncrement = getVerticalIncrement(); | |
int horizontalIncrement = clientAreaWidth / 4; | |
if (xAtOffset < 0) { | |
// always make 1/4 of a page visible | |
xAtOffset = Math.max(horizontalScrollOffset * -1, xAtOffset - horizontalIncrement); | |
scrollHorizontalBar(xAtOffset); | |
} | |
else | |
if (xAtOffset > clientAreaWidth) { | |
// always make 1/4 of a page visible | |
xAtOffset = Math.min(contentWidth - horizontalScrollOffset, xAtOffset + horizontalIncrement); | |
scrollHorizontalBar(xAtOffset - clientAreaWidth); | |
} | |
if (line < topIndex) { | |
setVerticalScrollOffset(line * verticalIncrement, true); | |
} | |
else | |
if (line > getBottomIndex()) { | |
setVerticalScrollOffset((line - getBottomIndex()) * verticalIncrement + verticalScrollOffset, true); | |
} | |
} | |
/** | |
* Scrolls the selection into view. | |
* <p> | |
* | |
* @exception SWTException <ul> | |
* <li>ERROR_WIDGET_DISPOSED - if the receiver has been disposed</li> | |
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the receiver</li> | |
* </ul> | |
*/ | |
public void showSelection() { | |
checkWidget(); | |
showOffset(selection.x); | |
showOffset(selection.y); | |
} | |
/** | |
* Returns the width of the specified text. Expand tabs to tab stops using | |
* the widget tab width. | |
* <p> | |
* | |
* @param line line to be measured. | |
* @param lineIndex index of the line relative to the first kine of the | |
* document | |
* @param length number of characters to measure. Tabs are counted | |
* as one character in this parameter. | |
* @param gc GC to use for measuring text | |
* @return width of the text with tabs expanded to tab stops or 0 if the | |
* length is beyond the text length. | |
*/ | |
int textWidth(String line, int lineIndex, int length, GC gc) { | |
StyleRange[] styles = null; | |
int lineOffset = content.getOffsetAtLine(lineIndex); | |
StyledTextEvent event = getLineStyleData(lineOffset, line); | |
if (event != null) { | |
styles = filterLineStyles(event.styles); | |
} | |
return textWidth(line, lineOffset, 0, length, styles, 0, gc); | |
} | |
/** | |
* Returns the width of the specified text. Expand tabs to tab stops using | |
* the widget tab width. | |
* <p> | |
* | |
* @param text text to be measured. | |
* @param lineOffset offset of the first character in the line. | |
* @param startOffset offset of the character to start measuring and | |
* expand tabs. | |
* @param length number of characters to measure. Tabs are counted | |
* as one character in this parameter. | |
* @param styles line styles | |
* @param startXOffset x position of "startOffset" in "text". Used for | |
* calculating tab stops | |
* @param gc GC to use for measuring text | |
* @return width of the text with tabs expanded to tab stops or 0 if the | |
* startOffset or length is outside the specified text. | |
*/ | |
int textWidth(String text, int lineOffset, int startOffset, int length, StyleRange[] lineStyles, int startXOffset, GC gc) { | |
int paintX = 0; | |
int endOffset = startOffset + length; | |
int textLength = text.length(); | |
FontData fontData = gc.getFont().getFontData()[0]; | |
if (startOffset < 0 || startOffset >= textLength || startOffset + length > textLength) { | |
return paintX; | |
} | |
for (int i = startOffset; i < endOffset; i++) { | |
int tabIndex = text.indexOf(TAB, i); | |
// is tab not present or past the rendering range? | |
if (tabIndex == -1 || tabIndex > endOffset) { | |
tabIndex = endOffset; | |
} | |
if (tabIndex != i) { | |
String tabSegment = text.substring(i, tabIndex); | |
if (lineStyles != null) { | |
paintX = styledTextWidth(tabSegment, lineOffset + i, lineStyles, paintX, 0, gc, false); | |
} | |
else { | |
fontData = setLineFont(gc, fontData, SWT.NORMAL); | |
paintX += gc.stringExtent(tabSegment).x; | |
} | |
if (tabIndex != endOffset && tabWidth > 0) { | |
paintX += tabWidth; | |
paintX -= (startXOffset + paintX) % tabWidth; | |
} | |
i = tabIndex; | |
} | |
else | |
if (tabWidth > 0) { | |
paintX += tabWidth; | |
paintX -= (startXOffset + paintX) % tabWidth; | |
} | |
} | |
return paintX; | |
} | |
/** | |
* Measures the text as rendered at the specified location. Expand tabs to tab stops using | |
* the widget tab width. | |
* <p> | |
* | |
* @param text text to draw | |
* @param textStartOffset offset of the first character in text relative | |
* to the first character in the document | |
* @param lineStyles styles of the line | |
* @param paintX x location to start drawing at | |
* @param paintY y location to draw at | |
* @param gc GC to draw on | |
* @param drawText true=measure and draw text, false=measure text only | |
* @return x location where drawing stopped or 0 if the startOffset or | |
* length is outside the specified text. | |
*/ | |
int styledTextWidth(String text, int textStartOffset, StyleRange[] lineStyles, int paintX, int paintY, GC gc, boolean drawText) { | |
FontData fontData = gc.getFont().getFontData()[0]; | |
String textSegment; | |
int textLength = text.length(); | |
int textIndex = 0; | |
for (int styleIndex = 0; styleIndex < lineStyles.length; styleIndex++) { | |
StyleRange style = lineStyles[styleIndex]; | |
int styleSegmentStart = style.start - textStartOffset; | |
int textEnd; | |
if (styleSegmentStart + style.length < 0) { | |
continue; | |
} | |
if (styleSegmentStart >= textLength) { | |
break; | |
} | |
// is there a style for the current string position? | |
if (textIndex < styleSegmentStart) { | |
fontData = setLineFont(gc, fontData, SWT.NORMAL); | |
textSegment = text.substring(textIndex, styleSegmentStart); | |
if (drawText) { | |
gc.drawString(textSegment, paintX - horizontalScrollOffset, paintY, true); | |
} | |
paintX += gc.stringExtent(textSegment).x; | |
textIndex = styleSegmentStart; | |
} | |
textEnd = Math.min(textLength, styleSegmentStart + style.length); | |
fontData = setLineFont(gc, fontData, style.fontStyle); | |
textSegment = text.substring(textIndex, textEnd); | |
if (drawText) { | |
gc.drawString(textSegment, paintX - horizontalScrollOffset, paintY, true); | |
} | |
paintX += gc.stringExtent(textSegment).x; | |
textIndex = textEnd; | |
} | |
// is there unmeasured and unstyled text? | |
if (textIndex < textLength) { | |
fontData = setLineFont(gc, fontData, SWT.NORMAL); | |
textSegment = text.substring(textIndex, textLength); | |
if (drawText) { | |
gc.drawString(textSegment, paintX - horizontalScrollOffset, paintY, true); | |
} | |
paintX += gc.stringExtent(textSegment).x; | |
} | |
return paintX; | |
} | |
/** | |
* Updates the selection and caret position depending on the text change. | |
* If the selection intersects with the replaced text, the selection is | |
* reset and the caret moved to the end of the new text. | |
* If the selection is behind the replaced text it is moved so that the | |
* same text remains selected. If the selection is before the replaced text | |
* it is left unchanged. | |
* <p> | |
* | |
* @param startOffset offset of the text change | |
* @param replacedLength length of text being replaced | |
* @param newLength length of new text | |
*/ | |
void updateSelection(int startOffset, int replacedLength, int newLength) { | |
if (selection.y <= startOffset) { | |
// selection ends before text change | |
return; | |
} | |
if (selection.x < startOffset) { | |
// clear selection fragment before text change | |
redrawRange(selection.x, startOffset - selection.x, true); | |
} | |
if (selection.y > startOffset + replacedLength && selection.x < startOffset + replacedLength) { | |
// clear selection fragment after text change. | |
// do this only when the selection is actually affected by the | |
// change. Selection is only affected if it intersects the change (1GDY217). | |
int netNewLength = newLength - replacedLength; | |
int redrawStart = startOffset + newLength; | |
redrawRange(redrawStart, selection.y + netNewLength - redrawStart, true); | |
} | |
if (selection.y > startOffset && selection.x < startOffset + replacedLength) { | |
// selection intersects replaced text. set caret behind text change | |
internalSetSelection(startOffset + newLength, 0); | |
// always update the caret location. fixes 1G8FODP | |
setCaretLocation(); | |
} | |
else { | |
// move selection to keep same text selected | |
internalSetSelection(selection.x + newLength - replacedLength, selection.y - selection.x); | |
// always update the caret location. fixes 1G8FODP | |
setCaretLocation(); | |
} | |
} | |
/** | |
* Returns whether the widget can have only one line. | |
* <p> | |
* | |
* @return true if widget can have only one line, false if widget can have | |
* multiple lines | |
*/ | |
boolean isSingleLine() { | |
return (getStyle() & SWT.SINGLE) != 0; | |
} | |
} |