Class BookmarkPropertiesDialog

  • All Implemented Interfaces:
    IShellProvider

    public class BookmarkPropertiesDialog
    extends org.eclipse.ui.views.markers.internal.DialogMarkerProperties
    Shows the properties of a new or existing bookmark This class was made public in 3.3.
    Since:
    3.3
    • Constructor Detail

      • BookmarkPropertiesDialog

        public BookmarkPropertiesDialog​(Shell parentShell)
        Creates the dialog. By default this dialog creates a new bookmark. To set the resource and initial attributes for the new bookmark, use setResource and setInitialAttributes. To show or modify an existing bookmark, use setMarker.
        Parameters:
        parentShell - the parent shell
      • BookmarkPropertiesDialog

        public BookmarkPropertiesDialog​(Shell parentShell,
                                        String title)
        Creates the dialog. By default this dialog creates a new bookmark. To set the resource and initial attributes for the new bookmark, use setResource and setInitialAttributes. To show or modify an existing bookmark, use setMarker.
        Parameters:
        parentShell - the parent shell
        title - the title for the dialog
    • Method Detail

      • setMarker

        public void setMarker​(IMarker marker)
        Sets the marker to show or modify.
        Overrides:
        setMarker in class org.eclipse.ui.views.markers.internal.DialogMarkerProperties
        Parameters:
        marker - the marker, or null to create a new marker
      • getMarker

        public IMarker getMarker()
        Returns the marker being created or modified. For a new marker, this returns null until the dialog returns, but is non-null after.
        Overrides:
        getMarker in class org.eclipse.ui.views.markers.internal.DialogMarkerProperties
        Returns:
        the marker
      • setResource

        public void setResource​(IResource resource)
        Sets the resource to use when creating a new bookmark. If not set, the new bookmark is created on the workspace root.
        Overrides:
        setResource in class org.eclipse.ui.views.markers.internal.DialogMarkerProperties
        Parameters:
        resource - the resource
      • getResource

        public IResource getResource()
        Returns the resource to use when creating a new bookmark, or null if none has been set. If not set, the new bookmark is created on the workspace root.
        Overrides:
        getResource in class org.eclipse.ui.views.markers.internal.DialogMarkerProperties
        Returns:
        the resource
      • setInitialAttributes

        public void setInitialAttributes​(Map<String,​Object> initialAttributes)
        Sets initial attributes to use when creating a new bookmark. If not set, the new bookmark is created with default attributes.
        Overrides:
        setInitialAttributes in class org.eclipse.ui.views.markers.internal.DialogMarkerProperties
        Parameters:
        initialAttributes - the initial attributes
      • getInitialAttributes

        public Map<String,​Object> getInitialAttributes()
        Returns the initial attributes to use when creating a new bookmark, or null if not set. If not set, the new bookmark is created with default attributes.
        Overrides:
        getInitialAttributes in class org.eclipse.ui.views.markers.internal.DialogMarkerProperties
        Returns:
        the initial attributes
      • getModifyOperationTitle

        protected String getModifyOperationTitle()
        Description copied from class: org.eclipse.ui.views.markers.internal.DialogMarkerProperties
        Return the string that describes a modify marker operation. Subclasses may override to more specifically describe the marker.
        Overrides:
        getModifyOperationTitle in class org.eclipse.ui.views.markers.internal.DialogMarkerProperties
      • getCreateOperationTitle

        protected String getCreateOperationTitle()
        Description copied from class: org.eclipse.ui.views.markers.internal.DialogMarkerProperties
        Return the string that describes a create marker operation. Subclasses may override to more specifically describe the marker.
        Overrides:
        getCreateOperationTitle in class org.eclipse.ui.views.markers.internal.DialogMarkerProperties