org.netbeans.modules.bugtracking.spi

Interface IssueController

public interface IssueController

Provides access to an Issue's UI.

Every Issue is expected to provide at least some visual component. Typically this would be an Issue editor making it possible to create and modify issues.

When viewing, creating or editing a new Issue, the UI is presented in an TopComponent in the editor area. Fire PROP_CHANGED to notify the Issue TopComponent that the UI state changed, IssueController.isChanged() will be called accordingly to determine if the IDE-s general SaveAction should be enabled. On save or TopComponent close are then the saveChanges() and discardUnsavedChanges() methods called accordingly.

Since:

1.85

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROP_CHANGED Fired when the data presented in the Issue UI were changed by the user.

Method Summary

Modifier and Type	Method and Description
void	addPropertyChangeListener(PropertyChangeListener l) Registers a PropertyChangeListener.
void	closed() Called when the component returned by this controller was closed.
boolean	discardUnsavedChanges() This method is called when Discard was chosen on close of an Issue TopComponent.
JComponent	getComponent() Returns a visual Issue component.
HelpCtx	getHelpCtx() Returns the help context associated with this controllers visual component.
boolean	isChanged() Determines whether the state of the UI has changed and is supposed to be saved.
void	opened() Called when the component returned by this controller was opened.
void	removePropertyChangeListener(PropertyChangeListener l) Unregisters a PropertyChangeListener.
boolean	saveChanges() This method is called when the general IDE Save button is pressed or when Save was chosen on close of an Issue TopComponent.

Field Detail

PROP_CHANGED

static final String PROP_CHANGED

Fired when the data presented in the Issue UI were changed by the user.

See Also:

Constant Field Values

Method Detail

getComponent

JComponent getComponent()

Returns a visual Issue component.

Returns:

a visual component representing an Issue

Since:

1.85

getHelpCtx

HelpCtx getHelpCtx()

Returns the help context associated with this controllers visual component.

Returns:

a HelpCtx

Since:

1.85

opened

void opened()

Called when the component returned by this controller was opened.

Since:

1.85

closed

void closed()

Called when the component returned by this controller was closed.

Since:

1.85

saveChanges

boolean saveChanges()

This method is called when the general IDE Save button is pressed or when Save was chosen on close of an Issue TopComponent.

Returns:

true in case the save worked, otherwise false

Since:

1.85

discardUnsavedChanges

boolean discardUnsavedChanges()

This method is called when Discard was chosen on close of an Issue TopComponent.

Returns:

true in case the discard worked, otherwise false

Since:

1.85

isChanged

boolean isChanged()

Determines whether the state of the UI has changed and is supposed to be saved.

Returns:

true in case there are changes to be saved, otherwise false

addPropertyChangeListener

void addPropertyChangeListener(PropertyChangeListener l)

Registers a PropertyChangeListener.

Parameters:

l - a PropertyChangeListener

Since:

1.85

removePropertyChangeListener

void removePropertyChangeListener(PropertyChangeListener l)

Unregisters a PropertyChangeListener.

Parameters:

l - a PropertyChangeListener

Since:

1.85