|
Eclipse Platform Release 3.7 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.jface.text.templates.Template
public class Template
A template consisting of a name and a pattern.
Clients may instantiate this class. May become final in the future.
| Constructor Summary | |
|---|---|
Template()
Creates an empty template. |
|
Template(String name,
String description,
String contextTypeId,
String pattern)
Deprecated. as of 3.1 replaced by Template(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 | |
|---|---|
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)
Returns true if template is enabled and matches the context,
false otherwise. |
void |
setContextTypeId(String contextTypeId)
Deprecated. Templates should never be modified |
void |
setDescription(String description)
Deprecated. Templates should never be modified |
void |
setName(String name)
Deprecated. Templates should never be modified |
void |
setPattern(String pattern)
Deprecated. Templates should never be modified |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public Template()
public Template(Template template)
template - the template to copy
public Template(String name,
String description,
String contextTypeId,
String pattern)
Template(String, String, String, String, boolean)
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
public Template(String name,
String description,
String contextTypeId,
String pattern,
boolean isAutoInsertable)
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| Method Detail |
|---|
public int hashCode()
hashCode in class Objectpublic void setDescription(String description)
description - the new descriptionpublic String getDescription()
public void setContextTypeId(String contextTypeId)
contextTypeId - the new context type namepublic String getContextTypeId()
public void setName(String name)
name - the name of the templatepublic String getName()
public void setPattern(String pattern)
pattern - the new pattern of the templatepublic String getPattern()
public boolean matches(String prefix,
String contextTypeId)
true if template is enabled and matches the context,
false otherwise.
prefix - the prefix (e.g. inside a document) to matchcontextTypeId - the context type id to match
true if template is enabled and matches the context,
false otherwisepublic boolean equals(Object o)
equals in class Objectpublic boolean isAutoInsertable()
|
Eclipse Platform Release 3.7 |
|||||||||
| 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, 2011. All rights reserved.