|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A text viewer turns a text widget into a document-based text widget. It supports the following kinds of listeners:
activatePlugins
call. Most plug-ins can be defined per content type.
Content types are derived from the partitioning of the text viewer's input document.A text viewer also provides the concept of event consumption. Events handled by the viewer can be filtered and processed by a dynamic event consumer.
A text viewer provides several text editing functions, some of them are configurable, through a text operation target interface. It also supports a presentation mode in which it only shows specified sections of its document. The viewer's presentation mode does not affect any client of the viewer other than text listeners.
Clients may implement this interface or use the standard implementation
TextViewer
.
IDocument
,
ITextInputListener
,
IViewportListener
,
ITextListener
,
IEventConsumer
Method Summary | |
void |
activatePlugins()
Activates the installed plug-ins. |
void |
addTextInputListener(ITextInputListener listener)
Adds a text input listener to this viewer. |
void |
addTextListener(ITextListener listener)
Adds a text listener to this viewer. |
void |
addViewportListener(IViewportListener listener)
Adds the given viewport listener to this viewer. |
void |
changeTextPresentation(TextPresentation presentation,
boolean controlRedraw)
Applies the color information encoded in the given text presentation. |
int |
getBottomIndex()
Returns the visible line with the highest line number. |
int |
getBottomIndexEndOffset()
Returns the document offset of the lower right corner of this viewer's viewport. |
IDocument |
getDocument()
Returns the text viewer's input document. |
IFindReplaceTarget |
getFindReplaceTarget()
Returns the find/replace operation target of this viewer. |
Point |
getSelectedRange()
Returns the range of the current selection in coordinates of this viewer's document. |
ISelectionProvider |
getSelectionProvider()
Returns a selection provider dedicated to this viewer. |
ITextOperationTarget |
getTextOperationTarget()
Returns the text operation target of this viewer. |
StyledText |
getTextWidget()
Returns this viewer's SWT control, null if the control is disposed. |
int |
getTopIndex()
Returns the visible line with the smallest line number. |
int |
getTopIndexStartOffset()
Returns the document offset of the upper left corner of this viewer's viewport. |
int |
getTopInset()
Returns the vertical offset of the first visible line. |
IRegion |
getVisibleRegion()
Returns the current visible region of this viewer's document. |
void |
invalidateTextPresentation()
Marks the currently applied text presentation as invalid. |
boolean |
isEditable()
Returns whether the shown text can be manipulated. |
boolean |
overlapsWithVisibleRegion(int offset,
int length)
Returns whether a given range overlaps with the visible region of this viewer's document. |
void |
removeTextInputListener(ITextInputListener listener)
Removes the given listener from this viewer's set of text input listeners. |
void |
removeTextListener(ITextListener listener)
Removes the given listener from this viewer's set of text listeners. |
void |
removeViewportListener(IViewportListener listener)
Removes the given listener from this viewer's set of viewport listeners. |
void |
resetPlugins()
Resets the installed plug-ins. |
void |
resetVisibleRegion()
Resets the region of this viewer's document which is visible in the presentation. |
void |
revealRange(int offset,
int length)
Ensures that the given range is visible. |
void |
setAutoIndentStrategy(IAutoIndentStrategy strategy,
String contentType)
Sets this viewer's auto indent strategy for the given content type. |
void |
setDefaultPrefixes(String[] defaultPrefixes,
String contentType)
Sets the string that is used as prefix when lines of the given content type are prefixed by the prefix text operation. |
void |
setDocument(IDocument document)
Sets the given document as the text viewer's model and updates the presentation accordingly. |
void |
setDocument(IDocument document,
int visibleRegionOffset,
int visibleRegionLength)
Sets the given document as this viewer's model and makes the specified region visible in the presentation. |
void |
setEditable(boolean editable)
Sets the editable mode. |
void |
setEventConsumer(IEventConsumer consumer)
Registers an event consumer with this viewer. |
void |
setIndentPrefixes(String[] indentPrefixes,
String contentType)
Sets the strings that are used as prefixes when lines of the given content type are shifted using the shift text operation. |
void |
setSelectedRange(int offset,
int length)
Sets the selection to the specified range. |
void |
setTextColor(Color color)
Applies the given color to this viewer's selection. |
void |
setTextColor(Color color,
int offset,
int length,
boolean controlRedraw)
Applies the given color to the specified section of this viewer. |
void |
setTextDoubleClickStrategy(ITextDoubleClickStrategy strategy,
String contentType)
Sets this viewer's text double click strategy for the given content type. |
void |
setTextHover(ITextHover textViewerHover,
String contentType)
Sets this viewer's text hover for the given content type. |
void |
setTopIndex(int index)
Scrolls the widget so the the given index is the line with the smallest line number of all visible lines. |
void |
setUndoManager(IUndoManager undoManager)
Sets this viewer's undo manager. |
void |
setVisibleRegion(int offset,
int length)
Sets the region of this viewer's document which will be visible in the presentation. |
Method Detail |
public StyledText getTextWidget()
null
if the control is disposed.
public void setUndoManager(IUndoManager undoManager)
undoManager
- the new undo manager. null
is a valid argument.public void setTextDoubleClickStrategy(ITextDoubleClickStrategy strategy, String contentType)
strategy
- the new double click strategy. null
is a valid argument.contentType
- the type for which the strategy is registeredpublic void setAutoIndentStrategy(IAutoIndentStrategy strategy, String contentType)
strategy
- the new auto indent strategy. null
is a valid argument.contentType
- the type for which the strategy is registeredpublic void setTextHover(ITextHover textViewerHover, String contentType)
textViewerHover
- the new hover. null
is a valid argument.contentType
- the type for which the hover is registeredpublic void activatePlugins()
public void resetPlugins()
IUndoManager
has been installed on this text viewer, the manager's list of remembered
text editing operations is removed.
public void addViewportListener(IViewportListener listener)
listener
- the listener to be addedpublic void removeViewportListener(IViewportListener listener)
listener
- the listener to be removedpublic void addTextListener(ITextListener listener)
listener
- the listener to be addedpublic void removeTextListener(ITextListener listener)
listener
- the listener to be removedpublic void addTextInputListener(ITextInputListener listener)
listener
- the listener to be addedpublic void removeTextInputListener(ITextInputListener listener)
listener
- the listener to be removedpublic void setDocument(IDocument document)
TextEvent
is
issued. This text event does not carry a related document event.
document
- the viewer's new input documentpublic IDocument getDocument()
public void setEventConsumer(IEventConsumer consumer)
consumer
- the viewer's event consumer. null
is a valid argument.public void setEditable(boolean editable)
editable
- the editable modepublic boolean isEditable()
public void setDocument(IDocument document, int visibleRegionOffset, int visibleRegionLength)
TextEvent
is issued. The text event does not carry a
related document event. This method is a convenience method for
setDocument(document);setVisibleRegion(offset, length)
.
document
- the new input documentvisibleRegionOffset
- the offset of the visible regionvisibleRegionLength
- the length of the visible regionpublic void setVisibleRegion(int offset, int length)
offset
- the offset of the visible regionlength
- the length of the visible regionpublic void resetVisibleRegion()
public IRegion getVisibleRegion()
setVisibleRegion
if the document has been modified since then.
public boolean overlapsWithVisibleRegion(int offset, int length)
true
if the specified range overlaps with the visible regionpublic void changeTextPresentation(TextPresentation presentation, boolean controlRedraw)
controlRedraw
tells this viewer whether it should take care of
redraw management or not. If, e.g., this call is one in a sequence of multiple
coloring calls, it is more appropriate to explicitly control redrawing at the
beginning and the end of the sequence.
presentation
- the presentation to be applied to this viewercontrolRedraw
- indicates whether this viewer should manage redrawspublic void invalidateTextPresentation()
public void setTextColor(Color color)
color
- the color to be appliedpublic void setTextColor(Color color, int offset, int length, boolean controlRedraw)
controlRedraw
tells this viewer whether it should take care of
redraw management or not.
color
- the color to be appliedoffset
- the offset of the range to be coloredlength
- the length of the range to be coloredcontrolRedraw
- indicates whether this viewer should manage redrawspublic ITextOperationTarget getTextOperationTarget()
public IFindReplaceTarget getFindReplaceTarget()
public void setDefaultPrefixes(String[] defaultPrefixes, String contentType)
defaultPrefixes
- the prefixes to be usedcontentType
- the content type for which the prefixes are specifiedpublic void setIndentPrefixes(String[] indentPrefixes, String contentType)
indentPrefixes
- the prefixes to be usedcontentType
- the content type for which the prefixes are specifiedpublic void setSelectedRange(int offset, int length)
offset
- the offset of the selection rangelength
- the length of the selection rangepublic Point getSelectedRange()
public ISelectionProvider getSelectionProvider()
public void revealRange(int offset, int length)
offset
- the offset of the range to be revealedlength
- the length of the range to be revealedpublic void setTopIndex(int index)
index
- the line which should become the top most linepublic int getTopIndex()
public int getTopIndexStartOffset()
public int getBottomIndex()
public int getBottomIndexEndOffset()
public int getTopInset()
|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |