|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.ui.console.AbstractConsole
Common function for consoles.
Clients implementing consoles should subclass this class.
Constructor Summary | |
AbstractConsole(String name,
ImageDescriptor imageDescriptor)
Constructs a new console with the given name and image. |
Method Summary | |
void |
addPropertyChangeListener(IPropertyChangeListener listener)
Adds a listener for changes to properties of this console. |
protected void |
dispose()
Called when this console is removed from the console manager. |
void |
firePropertyChange(Object source,
String property,
Object oldValue,
Object newValue)
Notify all listeners that the given property has changed. |
ImageDescriptor |
getImageDescriptor()
Returns an image descriptor for this console, or null
if none. |
String |
getName()
Returns the name of this console. |
protected void |
init()
Called when this console is added to the console manager. |
void |
removePropertyChangeListener(IPropertyChangeListener listener)
Removes the given property listener from this console page. |
protected void |
setImageDescriptor(ImageDescriptor imageDescriptor)
Sets the image descriptor for this console to the specified value and notifies property listeners of the change. |
protected void |
setName(String name)
Sets the name of this console to the specified value and notifies property listeners of the change. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.eclipse.ui.console.IConsole |
createPage |
Constructor Detail |
public AbstractConsole(String name, ImageDescriptor imageDescriptor)
name
- console name, cannot be null
imageDescriptor
- image descriptor, or null
if noneMethod Detail |
public String getName()
IConsole
getName
in interface IConsole
protected void setName(String name)
name
- the new namepublic ImageDescriptor getImageDescriptor()
IConsole
null
if none.
getImageDescriptor
in interface IConsole
null
if noneprotected void setImageDescriptor(ImageDescriptor imageDescriptor)
imageDescriptor
- the new image descriptorpublic void addPropertyChangeListener(IPropertyChangeListener listener)
IConsole
The changes supported by the console view are as follows:
IBasicPropertyConstants.P_TEXT
- indicates the name
of a console has changedIBasicPropertyConstants.P_IMAGE
- indicates the image
of a console has changedClients may define additional properties as required.
addPropertyChangeListener
in interface IConsole
listener
- a property change listenerpublic void removePropertyChangeListener(IPropertyChangeListener listener)
IConsole
removePropertyChangeListener
in interface IConsole
listener
- a property listenerpublic void firePropertyChange(Object source, String property, Object oldValue, Object newValue)
source
- the object on which a property has changedproperty
- identifier of the property that has changedoldValue
- the old value of the property, or null
newValue
- the new value of the property, or null
protected void init()
protected void dispose()
|
Eclipse Platform Release 3.0 |
||||||||||
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, 2004. All rights reserved.