|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IEditModelFactory
IEditModelFactory creates instances of IEditModels and IEditModelScribblers.
Clients may access the default implementation of the factory via
eINSTANCE
.
Clients are recommended to build most of the customization logic (such as
determining the interesting resources, and the appropriate label for their
edit models through the methods made available in
IEditModelScribbler
. Then
clients may rely on
createScribblerForRead(IProject, IScribblerDomain)
and
createScribblerForWrite(IProject, IScribblerDomain)
.
Field Summary | |
---|---|
static IEditModelFactory |
eINSTANCE
The public singleton instance of the IEditModelFactory. |
Method Summary | |
---|---|
IEditModelScribbler |
createScribbler(IProject aProject,
java.lang.String editModelLabel,
IScribblerDomain[] domains,
boolean toMakeReadonly)
Clients may create a scribbler using an array of IScribblerDomains for a specific edit model (identified by {aProject, editModelLabel}. |
IEditModelScribbler |
createScribblerForRead(IProject aProject,
IScribblerDomain domain)
Create a scribbler using the project and the given domain. |
IEditModelScribbler |
createScribblerForRead(IProject aProject,
java.lang.String editModelLabel,
IScribblerDomain[] domains)
Clients may create a scribbler using an array of IScribblerDomains for a specific edit model (identified by {aProject, editModelLabel}. |
IEditModelScribbler |
createScribblerForWrite(IProject aProject,
IScribblerDomain domain)
Create a scribbler using the project and the given domain. |
IEditModelScribbler |
createScribblerForWrite(IProject aProject,
java.lang.String editModelLabel,
IScribblerDomain[] domains)
Clients may create a scribbler using an array of IScribblerDomains for a specific edit model (identified by {aProject, editModelLabel}. |
IEditModel |
getEditModel(IProject aProject,
java.lang.String editModelLabel)
Return the IEditModel for the given project with the given label. |
Field Detail |
---|
static final IEditModelFactory eINSTANCE
Method Detail |
---|
IEditModel getEditModel(IProject aProject, java.lang.String editModelLabel)
aProject
- The scope of the IEditModel; general IEditModels are scoped to a
projecteditModelLabel
- The customized, client-chosen label for the edit model.
IEditModelScribbler createScribbler(IProject aProject, java.lang.String editModelLabel, IScribblerDomain[] domains, boolean toMakeReadonly) throws EditModelException
aProject
- Used with editModelLabel to identify the relevant IEditModel.editModelLabel
- Used with aProject to identify the relevant IEditModel.domains
- An array of IScribblerDomains that identify the interesting
resources.toMakeReadonly
- True indicates the returned scribbler should not allow save()
operations.
EditModelException
- If the project is inAccessible() or if another problem occurs
while locating the edit model or creating the scribbler.IEditModelScribbler createScribblerForRead(IProject aProject, IScribblerDomain domain) throws EditModelException
IScribblerDomain.getEditModelLabel()
. The scribbler returned will
not allow write operations.
aProject
- Used with IScribblerDomain.getEditModelLabel()
to
identify the relevant IEditModel.domain
- An IScribblerDomain that will identify the interesting
resources.
EditModelException
- If the project is inAccessible() or if another problem occurs
while locating the edit model or creating the scribbler.IEditModelScribbler createScribblerForWrite(IProject aProject, IScribblerDomain domain) throws EditModelException
IScribblerDomain.getEditModelLabel()
. The scribbler returned will
allow write operations.
aProject
- Used with IScribblerDomain.getEditModelLabel()
to
identify the relevant IEditModel.domain
- An IScribblerDomain that will identify the interesting
resources.
EditModelException
- If the project is inAccessible() or if another problem occurs
while locating the edit model or creating the scribbler.IEditModelScribbler createScribblerForRead(IProject aProject, java.lang.String editModelLabel, IScribblerDomain[] domains) throws EditModelException
aProject
- Used with editModelLabel to identify the relevant IEditModel.editModelLabel
- Used with aProject to identify the relevant IEditModel.domains
- An array of IScribblerDomains that identify the interesting
resources.
EditModelException
- If the project is inAccessible() or if another problem occurs
while locating the edit model or creating the scribbler.IEditModelScribbler createScribblerForWrite(IProject aProject, java.lang.String editModelLabel, IScribblerDomain[] domains) throws EditModelException
aProject
- Used with editModelLabel to identify the relevant IEditModel.editModelLabel
- Used with aProject to identify the relevant IEditModel.domains
- An array of IScribblerDomains that identify the interesting
resources.
EditModelException
- If the project is inAccessible() or if another problem occurs
while locating the edit model or creating the scribbler.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |