net.refractions.udig.issues
Interface IIssuesManager


public interface IIssuesManager

Provides access to the issues list and allows listeners to be added to it.

Since:
1.0.0
Author:
jones

Field Summary
static IIssuesManager defaultInstance
          The default issues manager.
 
Method Summary
 void addIssuesListListener(IIssuesListListener listener)
          Adds a listener to the issues list.
 void addListener(IIssuesManagerListener listener)
          Adds a listener to the manager.
 IIssuesList getIssuesList()
          Gets the global list of issues.
 boolean isDirty()
          Returns true if there is one or more dirty issues in the issues list.
 void removeIssuesListListener(IIssuesListListener listener)
          Removes a listener to the issues list.
 void removeListener(IIssuesManagerListener listener)
          Remove a listener from the manager.
 boolean save(IProgressMonitor monitor)
          Saves the issues list if necessary.
 void setIssuesList(IIssuesList newList)
          Sets the currently used IssuesList.
 

Field Detail

defaultInstance

static final IIssuesManager defaultInstance
The default issues manager.

Method Detail

addListener

void addListener(IIssuesManagerListener listener)
Adds a listener to the manager.

Parameters:
listener - listener to add.

removeListener

void removeListener(IIssuesManagerListener listener)
Remove a listener from the manager.

Parameters:
listener - listener to remove.

addIssuesListListener

void addIssuesListListener(IIssuesListListener listener)
Adds a listener to the issues list. Unlike IIssuesList.addListener(IIssuesListListener) this method will ensure that the listener is transfered to new lists when setIssuesList(IIssuesList) is called.

Parameters:
listener - the listener to add

removeIssuesListListener

void removeIssuesListListener(IIssuesListListener listener)
Removes a listener to the issues list.

WARNING: if addIssuesListListener(IIssuesListListener) is used to add a listener then removeIssuesListListener(IIssuesListListener) should be used to remove the listener because otherwise the listener will be added to a new list if setIssuesList(IIssuesList) is called.

Parameters:
listener - the listener to remove

setIssuesList

void setIssuesList(IIssuesList newList)
Sets the currently used IssuesList.

Parameters:
newList - the new list that will be used.

getIssuesList

IIssuesList getIssuesList()
Gets the global list of issues.

Returns:
the global list of issues.

save

boolean save(IProgressMonitor monitor)
             throws java.io.IOException
Saves the issues list if necessary.

Parameters:
monitor - Monitor that reports the save progress.
Returns:
returns true if a issue has been changed since last save and needs saving.
Throws:
java.io.IOException

isDirty

boolean isDirty()
Returns true if there is one or more dirty issues in the issues list. If the issues list is not a IRemoteIssuesList then this always returns false (since only IRemoteIssuesList need to be saved).

Returns:
true if there is one or more dirty issues in the issues list.