| org.eclipse.ui.views.markers.internal.DialogMarkerProperties
All known Subclasses: org.eclipse.ui.views.bookmarkexplorer.BookmarkPropertiesDialog, org.eclipse.ui.views.markers.internal.DialogTaskProperties, org.eclipse.ui.views.markers.internal.DialogProblemProperties,
| DialogMarkerProperties | | public class DialogMarkerProperties extends TrayDialog (Code) | | Shows the properties of a new or existing marker
In 3.3, this class was refactored to allow pre-existing public dialog classes
to share the implementation. Note that certain methods are exposed as API
in public subclasses, so changes to the methods in this class should be
treated carefully as they may affect API methods in subclasses. The specific
methods affected are documented in the method comment.
|
| Method Summary | |
| protected void | configureShell(Shell newShell)
Method declared on Window. | | protected void | createAttributesArea(Composite parent)
This method is intended to be overridden by subclasses. | | protected void | createButtonsForButtonBar(Composite parent)
Creates the OK and Cancel buttons. | | protected Control | createDialogArea(Composite parent)
Method declared on Dialog. | | protected void | createSeperator(Composite parent)
Creates a seperator. | | protected String | getCreateOperationTitle()
Return the string that describes a create marker operation. | | protected IDialogSettings | getDialogBoundsSettings()
| | protected Map | getInitialAttributes()
Returns the initial attributes to use when creating a new task,
or null if not set. | | protected IMarker | getMarker()
Returns the marker being created or modified. | | protected Map | getMarkerAttributes()
Returns the marker attributes to save back to the marker, based on the
current dialog fields. | | protected String | getModifyOperationTitle()
Return the string that describes a modify marker operation. | | protected IResource | getResource()
Returns the resource to use when creating a new task,
or null if none has been set. | | protected boolean | isDirty()
| | protected boolean | isEditable()
| | protected boolean | isResizable()
| | protected void | markDirty()
| | protected void | okPressed()
| | protected void | setInitialAttributes(Map initialAttributes)
Sets initial attributes to use when creating a new task. | | public void | setMarker(IMarker marker)
Sets the marker to show or modify.
IMPORTANT: Although this class is internal, there are public
subclasses that expose this method as API. | | public void | setResource(IResource resource)
Sets the resource to use when creating a new task.
If not set, the new task is created on the workspace root.
IMPORTANT: Although this class is internal, there are public
subclasses that expose this method as API. | | protected void | setType(String type)
Sets the marker type when creating a new marker. | | protected void | updateDialogForNewMarker()
Updates the dialog from the predefined attributes. | | protected void | updateDialogFromMarker()
Updates the dialog from the marker state. | | protected void | updateEnablement()
Updates widget enablement for the dialog. |
| DialogMarkerProperties | | public DialogMarkerProperties(Shell parentShell)(Code) | | Creates the dialog. By default this dialog creates a new marker. To set
the resource and initial attributes for the new marker, use
setResource and setInitialAttributes. To
show or modify an existing marker, use setMarker.
Parameters:
parentShell - the parent shell |
| DialogMarkerProperties | | public DialogMarkerProperties(Shell parentShell, String title)(Code) | | Creates the dialog. By default this dialog creates a new marker. To set
the resource and initial attributes for the new marker, use
setResource and setInitialAttributes. To
show or modify an existing marker, use setMarker.
Parameters:
parentShell - the parent shell
Parameters:
title - the title of the dialog |
| DialogMarkerProperties | | public DialogMarkerProperties(Shell parentShell, String title, String markerName)(Code) | | Creates the dialog. By default this dialog creates a new marker. To set
the resource and initial attributes for the new marker, use
setResource and setInitialAttributes. To
show or modify an existing marker, use setMarker.
Parameters:
parentShell - the parent shell
Parameters:
title - the title of the dialog
Parameters:
markerName - the name used to describe the specific kind of marker shown
since:
3.3 |
| configureShell | | protected void configureShell(Shell newShell)(Code) | | Method declared on Window.
|
| createAttributesArea | | protected void createAttributesArea(Composite parent)(Code) | | This method is intended to be overridden by subclasses. The attributes
area is created between the creation time area and the resource area.
Parameters:
parent - the parent composite |
| createButtonsForButtonBar | | protected void createButtonsForButtonBar(Composite parent)(Code) | | Creates the OK and Cancel buttons.
|
| createDialogArea | | protected Control createDialogArea(Composite parent)(Code) | | Method declared on Dialog.
|
| createSeperator | | protected void createSeperator(Composite parent)(Code) | | Creates a seperator.
|
| getCreateOperationTitle | | protected String getCreateOperationTitle()(Code) | | Return the string that describes a create marker operation.
Subclasses may override to more specifically describe the marker.
since:
3.3 |
| getDialogBoundsSettings | | protected IDialogSettings getDialogBoundsSettings()(Code) | | |
| getInitialAttributes | | protected Map getInitialAttributes()(Code) | | Returns the initial attributes to use when creating a new task,
or null if not set.
If not set, the new task is created with default attributes.
IMPORTANT: Although this method is protected and the class is
internal, there are public subclasses that expose this method as API.
Changes in this implementation should be treated as API changes.
the initial attributes
since:
3.3 |
| getMarker | | protected IMarker getMarker()(Code) | | Returns the marker being created or modified.
For a new marker, this returns null until
the dialog returns, but is non-null after.
IMPORTANT: Although this method is protected and the class is
internal, there are public subclasses that expose this method as API.
Changes in this implementation should be treated as API changes.
the marker
since:
3.3 |
| getMarkerAttributes | | protected Map getMarkerAttributes()(Code) | | Returns the marker attributes to save back to the marker, based on the
current dialog fields.
|
| getModifyOperationTitle | | protected String getModifyOperationTitle()(Code) | | Return the string that describes a modify marker operation.
Subclasses may override to more specifically describe the marker.
since:
3.3 |
| getResource | | protected IResource getResource()(Code) | | Returns the resource to use when creating a new task,
or null if none has been set.
If not set, the new task is created on the workspace root.
IMPORTANT: Although this method is protected and the class is
internal, there are public subclasses that expose this method as API.
Changes in this implementation should be treated as API changes.
the resource
since:
3.3 |
| isDirty | | protected boolean isDirty()(Code) | | true if the dirty flag has been set to true.false otherwise.
|
| isEditable | | protected boolean isEditable()(Code) | | true if the marker is editable or the dialog iscreating a new marker.false if the marker is not editable.
|
| isResizable | | protected boolean isResizable()(Code) | | |
| markDirty | | protected void markDirty()(Code) | | Sets the dialog's dirty flag to true
|
| okPressed | | protected void okPressed()(Code) | | Method declared on Dialog
|
| setInitialAttributes | | protected void setInitialAttributes(Map initialAttributes)(Code) | | Sets initial attributes to use when creating a new task.
If not set, the new task is created with default attributes.
IMPORTANT: Although this method is protected and the class is
internal, there are public subclasses that expose this method as API.
Changes in this implementation should be treated as API changes.
Parameters:
initialAttributes - the initial attributes
since:
3.3 |
| setMarker | | public void setMarker(IMarker marker)(Code) | | Sets the marker to show or modify.
IMPORTANT: Although this class is internal, there are public
subclasses that expose this method as API. Changes in
this implementation should be treated as API changes.
Parameters:
marker - the marker, or null to create a new marker
since:
3.3 |
| setResource | | public void setResource(IResource resource)(Code) | | Sets the resource to use when creating a new task.
If not set, the new task is created on the workspace root.
IMPORTANT: Although this class is internal, there are public
subclasses that expose this method as API. Changes in
this implementation should be treated as API changes.
Parameters:
resource - the resource |
| setType | | protected void setType(String type)(Code) | | Sets the marker type when creating a new marker.
Parameters:
type - the marker type
since:
3.3 this method is protected. |
| updateDialogForNewMarker | | protected void updateDialogForNewMarker()(Code) | | Updates the dialog from the predefined attributes.
|
| updateDialogFromMarker | | protected void updateDialogFromMarker()(Code) | | Updates the dialog from the marker state.
|
| updateEnablement | | protected void updateEnablement()(Code) | | Updates widget enablement for the dialog. Should be overridden by
subclasses.
|
|
|