|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.core.commands.common.EventManager
org.eclipse.core.commands.common.HandleObject
org.eclipse.core.commands.common.NamedHandleObject
org.eclipse.core.commands.Category
public final class Category
A logical group for a set of commands. A command belongs to exactly one category. The category has no functional effect, but may be used in graphical tools that want to group the set of commands somehow.
| Field Summary |
|---|
| Fields inherited from class org.eclipse.core.commands.common.NamedHandleObject |
|---|
description, name |
| Fields inherited from class org.eclipse.core.commands.common.HandleObject |
|---|
defined, id, string |
| Method Summary | |
|---|---|
void |
addCategoryListener(ICategoryListener categoryListener)
Adds a listener to this category that will be notified when this category's state changes. |
void |
define(java.lang.String name,
java.lang.String description)
Defines this category by giving it a name, and possibly a description as well. |
void |
removeCategoryListener(ICategoryListener categoryListener)
Removes a listener from this category. |
java.lang.String |
toString()
The string representation of this object -- for debugging purposes only. |
void |
undefine()
Makes this object becomes undefined. |
| Methods inherited from class org.eclipse.core.commands.common.NamedHandleObject |
|---|
getDescription, getName |
| Methods inherited from class org.eclipse.core.commands.common.HandleObject |
|---|
equals, getId, hashCode, isDefined |
| Methods inherited from class org.eclipse.core.commands.common.EventManager |
|---|
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
| Method Detail |
|---|
public final void addCategoryListener(ICategoryListener categoryListener)
categoryListener - The listener to be added; must not be null.
public final void define(java.lang.String name,
java.lang.String description)
Defines this category by giving it a name, and possibly a description as
well. The defined property automatically becomes true.
Notification is sent to all listeners that something has changed.
name - The name of this command; must not be null.description - The description for this command; may be null.public final void removeCategoryListener(ICategoryListener categoryListener)
categoryListener - The listener to be removed; must not be null.public java.lang.String toString()
HandleObject
toString in class HandleObjectnull.public void undefine()
HandleObjectnull. It should also send notification to any
listeners that these properties have changed.
undefine in class HandleObject
|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.