|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.text.templates.TemplateContext
Provides the context for a Template
being resolved. Keeps track
of resolved variables.
Clients may extend this class.
Constructor Summary | |
protected |
TemplateContext(TemplateContextType contextType)
Creates a template context of a particular context type. |
Method Summary | |
abstract boolean |
canEvaluate(Template template)
Tests if the specified template can be evaluated in this context. |
abstract TemplateBuffer |
evaluate(Template template)
Evaluates the template in this context and returns a template buffer. |
TemplateContextType |
getContextType()
Returns the context type of this context. |
String |
getVariable(String name)
Returns the value of a defined variable. |
boolean |
isReadOnly()
Returns true if the receiver is read-only, false otherwise. |
void |
setReadOnly(boolean readOnly)
Sets or clears the read-only flag. |
void |
setVariable(String name,
String value)
Defines the value of a variable. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
protected TemplateContext(TemplateContextType contextType)
contextType
- the context type of this contextMethod Detail |
public TemplateContextType getContextType()
public void setReadOnly(boolean readOnly)
readOnly
- the new read-only statepublic boolean isReadOnly()
true
if the receiver is read-only, false
otherwise.
true
if the receiver is read-only, false
otherwisepublic void setVariable(String name, String value)
name
- the name of the variablevalue
- the value of the variable, null
to undefine a variablepublic String getVariable(String name)
name
- the name of the variable
null
if the variable was not definedpublic abstract TemplateBuffer evaluate(Template template) throws BadLocationException, TemplateException
Evaluation means translating the template into a TemplateBuffer
,
resolving the defined variables in this context and possibly formatting
the resolved buffer.
template
- the template to evaluate
null
if the buffer could not be created
BadLocationException
- if evaluation fails due to concurrently changed documents etc.
TemplateException
- if the template specification is not validpublic abstract boolean canEvaluate(Template template)
Examples are templates defined for a different context (e.g. a javadoc template cannot be evaluated in Java context).
template
- the Template
to check
true
if template
can be evaluated
in this context, false
otherwise
|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.