|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A breakpoint organizer is used to categorize breakpoints and provides change notification when categorization has changed. Categories are represented as arbitrary adaptable objects. For example, projects could be used to categorize breakpoints. Images and labels for categories are generated via workbench adapaters.
Organizers may optionally support breakpoint recategorization.
Following is example plug-in XML for contributing a breakpoint organizer.
<extension point="org.eclipse.debug.ui.breakpointOrganizers"> <breakpointOrganizer class="com.example.BreakpointOrganizer" id="com.example.BreakpointOrganizer" label="Example Organizer" icon="icons/full/obj16/example_org.gif"/> </extension>The attributes are specified as follows:
class
Fully qualified name of a Java class that implements
IBreakpointOrganizerDelegate
.id
Unique identifier for this breakpoint organizer.label
Label for this organizer which is suitable for
presentation to the user.icon
Optional path to an icon which can be shown for this
organizerClients contributing a breakpoint organizer are intended to implement this interface.
Field Summary | |
---|---|
static String |
P_CATEGORY_CHANGED
Change event id when a category's breakpoints have changed. |
Method Summary | |
---|---|
void |
addBreakpoint(IBreakpoint breakpoint,
IAdaptable category)
Adds the specified breakpoint to the given category. |
void |
addPropertyChangeListener(IPropertyChangeListener listener)
Adds the specified listener. |
boolean |
canAdd(IBreakpoint breakpoint,
IAdaptable category)
Returns whether the given breakpoint can be categorized in the specified category. |
boolean |
canRemove(IBreakpoint breakpoint,
IAdaptable category)
Returns whether the given breakpoint can be removed from the given category. |
void |
dispose()
Disposes this breakpoint organizer. |
IAdaptable[] |
getCategories()
Returns all categories managed by this organizer, or null .
|
IAdaptable[] |
getCategories(IBreakpoint breakpoint)
Returns objects representing the categories of the specified breakpoint or null if this organizer cannot classify
the breakpoint. |
void |
removeBreakpoint(IBreakpoint breakpoint,
IAdaptable category)
Removes the specified breakpoint from the given category. |
void |
removePropertyChangeListener(IPropertyChangeListener listener)
Removes the specified listener. |
Field Detail |
public static final String P_CATEGORY_CHANGED
oldValue
of the PropertyChangeEvent
will be the
category that has changed, and the source of the event will the the
breakpoint organizer. Breakpoints in the category will be
recategorized when this event is fired.
IPropertyChangeListener
Method Detail |
public IAdaptable[] getCategories(IBreakpoint breakpoint)
null
if this organizer cannot classify
the breakpoint. Categories must return true
when sent
the message equals(Object)
with an equivalent category
as an argument.
breakpoint
- breakpoint to classify
null
public void addPropertyChangeListener(IPropertyChangeListener listener)
listener
- listener to addpublic void removePropertyChangeListener(IPropertyChangeListener listener)
listener
- listener to removepublic void addBreakpoint(IBreakpoint breakpoint, IAdaptable category)
canAdd(...)
returns true
for the given
breakpoint and category.
breakpoint
- breakpoint to recategorizecategory
- the breakpoint's new categorypublic void removeBreakpoint(IBreakpoint breakpoint, IAdaptable category)
canRemove(...)
returns true
for
the given breakpoint and category.
breakpoint
- breakpoint to recategorizecategory
- the category the breakpoint is remove frompublic boolean canAdd(IBreakpoint breakpoint, IAdaptable category)
breakpoint
- breakpoint to recatogorizecategory
- the category to add the breakpoint to
public boolean canRemove(IBreakpoint breakpoint, IAdaptable category)
breakpoint
- breakpoint to recategorizecategory
- the category to remove the breakpoint from
public IAdaptable[] getCategories()
null
.
When null
is returned, the breakpoints view only displays
categories that contain breakpoints. When a collection of categories
is returned the breakpoints will display all of the categories, some of
which may be empty.
null
public void dispose()
|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.