|
Eclipse Platform Release 3.4 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.ui.part.Page
org.eclipse.ui.texteditor.templates.AbstractTemplatesPage
Abstract default implementation for ITemplatesPage
.
Clients who are defining an editor may elect to provide a corresponding templates page. This templates page will be presented to the user via the Templates View (the user decides whether their workbench window contains this view) whenever that editor is active. This class should be subclassed by clients.
Internally, a AbstractTemplatesPage uses the template store to display different categories. A link to editor mode on the templates page allows to filtering of the categories to only that are supported in this context.
Constructor Summary | |
protected |
AbstractTemplatesPage(ITextEditor editor,
ISourceViewer viewer)
Creates a new templates page. |
Method Summary | |
void |
createControl(Composite ancestor)
Creates the SWT control for this page under the given parent control. |
protected SourceViewer |
createPatternViewer(Composite parent)
Creates, configures and returns a source viewer to present the template pattern on the templates page. |
void |
dispose()
Disposes of this page. |
protected Template |
editTemplate(Template template,
boolean edit,
boolean isNameModifiable)
Creates and opens a dialog to edit the given template. |
protected abstract String[] |
getContextTypeIds(IDocument document,
int offset)
Returns the context type ids supported at the given document offset. |
protected abstract ContextTypeRegistry |
getContextTypeRegistry()
Returns the context type registry used in this page. |
Control |
getControl()
Returns the SWT control for this page. |
protected Image |
getImage(Template template)
Returns the image to be used for the given template. |
protected SourceViewer |
getPatternViewer()
Returns the pattern viewer created by createPatternViewer() |
protected abstract String |
getPreferencePageId()
Returns the Template preference page id to be used by this template page. |
protected abstract IPreferenceStore |
getTemplatePreferenceStore()
Returns the preference store used to create the template store returned by getTemplateStore() . |
protected abstract TemplateStore |
getTemplateStore()
Returns the template store used in this page. |
protected abstract void |
insertTemplate(Template template,
IDocument document)
Inserts the given template into the editor. |
protected abstract boolean |
isValidTemplate(IDocument document,
Template template,
int offset,
int length)
Checks whether the given template is valid for the document at the given offset and length. |
void |
setFocus()
Asks this page to take focus within its pagebook view. |
protected void |
updatePatternViewer(Template template)
Update the pattern viewer to show the current template. |
Methods inherited from class org.eclipse.ui.part.Page |
getSite, init, makeContributions, setActionBars |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.eclipse.ui.part.IPageBookViewPage |
getSite, init |
Methods inherited from interface org.eclipse.ui.part.IPage |
setActionBars |
Constructor Detail |
protected AbstractTemplatesPage(ITextEditor editor, ISourceViewer viewer)
editor
- the editorviewer
- the source viewerMethod Detail |
public void createControl(Composite ancestor)
IPage
Clients should not call this method (the workbench calls this method when it needs to, which may be never).
createControl
in interface IPage
createControl
in class Page
public void setFocus()
IPage
setFocus
in interface IPage
setFocus
in class Page
public Control getControl()
IPage
getControl
in interface IPage
getControl
in class Page
public void dispose()
IPage
This is the last method called on the IPage
. Implementors should
clean up any resources associated with the page.
Note that there is no guarantee that createControl() has been called, so the control may never have been created.
dispose
in interface IPage
dispose
in class Page
protected Image getImage(Template template)
Clients can override to provide a different image.
template
- the template
protected Template editTemplate(Template template, boolean edit, boolean isNameModifiable)
template
- the template being editededit
- true
if the dialog allows editingisNameModifiable
- true
if the template name may be modified
null
if the editing failedprotected void updatePatternViewer(Template template)
Subclasses can extend this method to update their own pattern viewer.
template
- protected SourceViewer createPatternViewer(Composite parent)
Clients may override to provide a custom source viewer featuring e.g. syntax coloring.
parent
- the parent control
protected final SourceViewer getPatternViewer()
protected abstract void insertTemplate(Template template, IDocument document)
template
- the templatedocument
- the documentprotected abstract ContextTypeRegistry getContextTypeRegistry()
protected abstract TemplateStore getTemplateStore()
protected abstract IPreferenceStore getTemplatePreferenceStore()
getTemplateStore()
.
protected abstract String getPreferencePageId()
null
if none existsprotected abstract String[] getContextTypeIds(IDocument document, int offset)
document
- the documentoffset
- the offset
protected abstract boolean isValidTemplate(IDocument document, Template template, int offset, int length)
document
- the documenttemplate
- the templateoffset
- the offsetlength
- the length
true
if the template is valid
|
Eclipse Platform Release 3.4 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.