|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IIssue
Specifies an issue that requires the user's input to be dealt with. One example is an invalid feature.
Method Summary | |
---|---|
void |
addIssueListener(IIssueListener listener)
Adds a IIssueListener to the issue. |
void |
fixIssue(IViewPart part,
IEditorPart editor)
This is called when the user wishes to fix the issue. |
ReferencedEnvelope |
getBounds()
Returns the area that this issue affects. |
java.lang.String |
getDescription()
Gets the description of the Issue. |
java.lang.String |
getEditorID()
The id of the editor that will be opened to edit the Editor Input. |
IEditorInput |
getEditorInput()
If returns not null the framework will attempt to open an editor that can edit the input object. |
java.lang.String |
getExtensionID()
Returns the id of the extension definition for this type of Issue. |
java.lang.String |
getGroupId()
The GroupID groups sets of Issues. |
java.lang.String |
getId()
Returns the id of the issue. |
java.lang.String |
getPerspectiveID()
If not null the framework will open the identified perspective. |
Priority |
getPriority()
Returns the priority of the issue. |
java.lang.String |
getProblemObject()
Returns A one or two word name for the object that has the issue. |
java.lang.Object |
getProperty(java.lang.String property)
Gets a property of the issue. |
java.lang.String[] |
getPropertyNames()
Returns an array of all the property names in the issue. |
Resolution |
getResolution()
Indicates whether the issue has been resolved. |
void |
getViewMemento(IMemento memento)
If the ViewPart identified by getViewPartID is a view and the IMemento returned by this method is non-null, the view will be initialized with the memento. |
java.lang.String |
getViewPartId()
Returns the id of the ViewPart that the issue requires in order to be resolved. |
void |
init(IMemento memento,
IMemento viewMemento,
java.lang.String issueId,
java.lang.String groupId,
ReferencedEnvelope bounds)
Called by framework to initialize the Issue. |
void |
removeIssueListener(IIssueListener listener)
Removes a IIssueListener from the issue. |
void |
save(IMemento memento)
Populates the memento with data specialized for the issues type. |
void |
setDescription(java.lang.String description)
Sets the description of the issue. |
void |
setId(java.lang.String newId)
Sets the id of the issue. |
void |
setPriority(Priority priority)
Sets the priority of the issue. |
void |
setResolution(Resolution newResolution)
Sets the state of resolution. |
Method Detail |
---|
void addIssueListener(IIssueListener listener)
IIssueListener
to the issue. The IIssuesManager
listens to the issue in order to know which issues need
to be saved. If an implementation does not raise events when a property of the issue is changed and it does not call
IIssuesManager.save(IProgressMonitor)
then the change will not be saved.
listener
- listener to add.void removeIssueListener(IIssueListener listener)
IIssueListener
from the issue.
listener
- listener to remove.java.lang.String getViewPartId()
void getViewMemento(IMemento memento)
java.lang.String getEditorID()
getEditorInput()
does not return null and getEditorID()
also does not then the editor will be
opened by the framework (It does not need to be done in fixIssue() method).
IEditorInput getEditorInput()
java.lang.String getPerspectiveID()
java.lang.String getProblemObject()
java.lang.String getDescription()
void setDescription(java.lang.String description)
description
- Priority getPriority()
void setPriority(Priority priority)
void fixIssue(IViewPart part, IEditorPart editor)
This method can do other initializations and return or it can run the user through a workflow and only return when the problem is fixed or the user cancels the operation.
This method does NOT have to fix the issue
This method IS run in the display thread.
part
- The workbenchpart identified by getViewPartId() or null.editor
- The editor that was identified by getEditorID() or null.FeatureIssue
Resolution getResolution()
void setResolution(Resolution newResolution)
newResolution
- the new state.java.lang.String getId()
void setId(java.lang.String newId)
newId
- java.lang.String getGroupId()
java.lang.Object getProperty(java.lang.String property)
property
- the name/key of the propertyjava.lang.String[] getPropertyNames()
void init(IMemento memento, IMemento viewMemento, java.lang.String issueId, java.lang.String groupId, ReferencedEnvelope bounds)
memento
- The saved state of a Issue. May be null.viewMemento
- the memento for initializing the view, may be nullissueId
- the id the issue is assigned. getId()
must return the same id.groupId
- the group id of the issue.bounds
- the bounds of the issue.void save(IMemento memento)
fixIssue(IViewPart, IEditorPart)
needs to be saved in the memento.
State that is saved by the framework and is not required to be saved in this memento include:
memento
- the memento to populate with state data.java.lang.String getExtensionID()
The extension id is formed by the namespace of the plugin combined with the name of the extension element.
For example: The FeatureIssue's extension id would be: net.refractions.udig.issues.featureIssue because the issue implementation is in the Issues plugin (which the id net.refractions.udig.issues) and the extension name is featureIssue. The two are combined to form the id of the extension
ReferencedEnvelope getBounds()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |