Package org.eclipse.jface.text.templates
Class Template
- java.lang.Object
-
- org.eclipse.jface.text.templates.Template
-
public class Template extends Object
A template consisting of a name and a pattern.Clients may instantiate this class. May become final in the future.
- Since:
- 3.0
- Restriction:
- This class is not intended to be subclassed by clients.
-
-
Constructor Summary
Constructors Constructor Description Template()
Creates an empty template.Template(String name, String description, String contextTypeId, String pattern)
Deprecated.as of 3.1 replaced byTemplate(String, String, String, String, boolean)
Template(String name, String description, String contextTypeId, String pattern, boolean isAutoInsertable)
Creates a template.Template(Template template)
Creates a copy of a template.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
equals(Object o)
String
getContextTypeId()
Returns the id of the context type in which the template can be applied.String
getDescription()
Returns the description of the template.String
getName()
Returns the name of the template.String
getPattern()
Returns the template pattern.int
hashCode()
boolean
isAutoInsertable()
Returns the auto insertable property of the template.boolean
matches(String prefix, String contextTypeId)
Returnstrue
if template is enabled and matches the context,false
otherwise.void
setContextTypeId(String contextTypeId)
Deprecated.Templates should never be modifiedvoid
setDescription(String description)
Deprecated.Templates should never be modifiedvoid
setName(String name)
Deprecated.Templates should never be modifiedvoid
setPattern(String pattern)
Deprecated.Templates should never be modified
-
-
-
Constructor Detail
-
Template
public Template()
Creates an empty template.
-
Template
public Template(Template template)
Creates a copy of a template.- Parameters:
template
- the template to copy
-
Template
@Deprecated public Template(String name, String description, String contextTypeId, String pattern)
Deprecated.as of 3.1 replaced byTemplate(String, String, String, String, boolean)
Creates a template.- Parameters:
name
- the name of the templatedescription
- the description of the templatecontextTypeId
- the id of the context type in which the template can be appliedpattern
- the template pattern
-
Template
public Template(String name, String description, String contextTypeId, String pattern, boolean isAutoInsertable)
Creates a template.- Parameters:
name
- the name of the templatedescription
- the description of the templatecontextTypeId
- the id of the context type in which the template can be appliedpattern
- the template patternisAutoInsertable
- the auto insertable property of the template- Since:
- 3.1
-
-
Method Detail
-
setDescription
@Deprecated public void setDescription(String description)
Deprecated.Templates should never be modifiedSets the description of the template.- Parameters:
description
- the new description
-
getDescription
public String getDescription()
Returns the description of the template.- Returns:
- the description of the template
-
setContextTypeId
@Deprecated public void setContextTypeId(String contextTypeId)
Deprecated.Templates should never be modifiedSets the name of the context type in which the template can be applied.- Parameters:
contextTypeId
- the new context type name
-
getContextTypeId
public String getContextTypeId()
Returns the id of the context type in which the template can be applied.- Returns:
- the id of the context type in which the template can be applied
-
setName
@Deprecated public void setName(String name)
Deprecated.Templates should never be modifiedSets the name of the template.- Parameters:
name
- the name of the template
-
getName
public String getName()
Returns the name of the template.- Returns:
- the name of the template
-
setPattern
@Deprecated public void setPattern(String pattern)
Deprecated.Templates should never be modifiedSets the pattern of the template.- Parameters:
pattern
- the new pattern of the template
-
getPattern
public String getPattern()
Returns the template pattern.- Returns:
- the template pattern
-
matches
public boolean matches(String prefix, String contextTypeId)
Returnstrue
if template is enabled and matches the context,false
otherwise.- Parameters:
prefix
- the prefix (e.g. inside a document) to matchcontextTypeId
- the context type id to match- Returns:
true
if template is enabled and matches the context,false
otherwise
-
isAutoInsertable
public boolean isAutoInsertable()
Returns the auto insertable property of the template.- Returns:
- the auto insertable property of the template
- Since:
- 3.1
-
-