|
Eclipse Platform Release 3.2 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.jface.text.templates.TemplateVariable
public class TemplateVariable
A TemplateVariable represents a set of positions into a
TemplateBuffer with identical content each. TemplateVariableResolvers
can be used to resolve a template variable to a symbol available from the
TemplateContext.
Clients may instantiate and extend this class.
TemplateVariableResolver,
TemplateBuffer| Constructor Summary | |
|---|---|
TemplateVariable(String type,
String[] values,
int[] offsets)
Creates a template variable with multiple possible values. |
|
TemplateVariable(String type,
String defaultValue,
int[] offsets)
Creates a template variable. |
|
TemplateVariable(String type,
String name,
String[] values,
int[] offsets)
Creates a template variable with multiple possible values. |
|
TemplateVariable(String type,
String name,
String defaultValue,
int[] offsets)
Creates a template variable. |
|
| Method Summary | |
|---|---|
String |
getDefaultValue()
Returns the default value of the variable. |
int |
getLength()
Returns the length of the variable. |
String |
getName()
Returns the name of the variable. |
int[] |
getOffsets()
Returns the offsets of the variable. |
String |
getType()
Returns the type of the variable. |
String[] |
getValues()
Returns the possible values for this variable. |
boolean |
isUnambiguous()
Returns true if the variable is unambiguously resolved, false otherwise. |
void |
setOffsets(int[] offsets)
Sets the offsets of the variable. |
void |
setUnambiguous(boolean unambiguous)
Sets the isUnambiguous flag of the variable. |
void |
setValue(String value)
Sets the default value for this variable. |
void |
setValues(String[] values)
Sets the possible values for this variable, with the first being the default value. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public TemplateVariable(String type,
String defaultValue,
int[] offsets)
type - the type of the variabledefaultValue - the default value of the variableoffsets - the array of offsets of the variable
public TemplateVariable(String type,
String name,
String defaultValue,
int[] offsets)
type - the type of the variablename - the name of the variabledefaultValue - the default value of the variableoffsets - the array of offsets of the variable
public TemplateVariable(String type,
String[] values,
int[] offsets)
type - the type of the template variablevalues - the values available at this variable, non-emptyoffsets - the array of offsets of the variable
public TemplateVariable(String type,
String name,
String[] values,
int[] offsets)
type - the type of the variablename - the name of the variablevalues - the values available at this variable, non-emptyoffsets - the array of offsets of the variable| Method Detail |
|---|
public String getType()
public String getName()
public String getDefaultValue()
public String[] getValues()
public int getLength()
public void setOffsets(int[] offsets)
offsets - the new offsets of the variablepublic int[] getOffsets()
public final void setValue(String value)
setValues(new String[] { value }).
value - the new default valuepublic void setValues(String[] values)
values - a non-empty array of valuespublic void setUnambiguous(boolean unambiguous)
unambiguous - the new unambiguous state of the variablepublic boolean isUnambiguous()
true if the variable is unambiguously resolved, false otherwise.
true if the variable is unambiguously resolved, false otherwise
|
Eclipse Platform Release 3.2 |
|||||||||
| 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, 2006. All rights reserved.