|
Eclipse Platform Release 3.1 |
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
An arbitrary rendering of a memory block. A memory rendering is contributed
via the memoryRenderings
extension point.
Following is an example definition of a memory renderings extension.
<extension point="org.eclipse.debug.ui.memoryRenderings"> <memoryRenderingType id="com.example.asciiRendering" name="ASCII" class="com.example.RenderingFactory"> </memoryRenderingType> </extension>The attributes are specified as follows:
id
specifies a unique identifier for a type of memory renderingname
specifies a human readable label for a rendering typeclass
specifies the fully qualified name of the Java class
that implements IMemoryRenderingTypeDelegate
. Renderings are created
via this factory.
A rendering provides an image and label. To support dynamic labels and images, property
change notification is used with the following property constants defined in
IBasicPropertyConstants
:
P_TEXT
- indicates a label changeP_IMAGE
- indicates a image changeRenderings needing to synchronize with other renderings are intended to use property change notifications via its synchronization service. For example, when a rendering becomes visible, it can register for property change events with its rendering site's synchronization service, and when it becomes hidden it can deregister. When a rendering is activated, it should set itself as the synchrnoization provider in its rendering site and fire property change events to communicate information to interested listeners.
Clients contributing a memory rendering type are intended to implement this interface
and IMemoryRenderingTypeDelegate
. The factory will be used to create instances
of IMemoryRendering
.
Method Summary | |
---|---|
void |
activated()
Notification this rendering has become the active rendering. |
void |
addPropertyChangeListener(IPropertyChangeListener listener)
Adds a listener for property changes to this rendering. |
void |
becomesHidden()
Notification this rendering has become hidden in its container. |
void |
becomesVisible()
Notification this rendering has become visible in its container. |
Control |
createControl(Composite parent)
Creates the top level control for this rendering under the given parent composite. |
void |
deactivated()
Notification this rendering is no longer the active rendering. |
void |
dispose()
Disposes this rendering. |
Control |
getControl()
Returns the top level control for this rendering. |
Image |
getImage()
Returns an image for this rendering. |
String |
getLabel()
Returns a label for this rendering. |
IMemoryBlock |
getMemoryBlock()
Returns the memory block displayed by this rendering. |
String |
getRenderingId()
Returns the identifier associated with this rendering's type. |
void |
init(IMemoryRenderingContainer container,
IMemoryBlock block)
Initializes this rendering to be hosted in the given container, displaying the given memory block. |
void |
removePropertyChangeListener(IPropertyChangeListener listener)
Removes the given property change listener from this rendering. |
Methods inherited from interface org.eclipse.core.runtime.IAdaptable |
---|
getAdapter |
Method Detail |
public void init(IMemoryRenderingContainer container, IMemoryBlock block)
container
- container hosting this renderingblock
- the memory block to renderpublic Control createControl(Composite parent)
init
method has been
called.
Implementors are responsible for ensuring that
the created control can be accessed via getControl
parent
- the parent compositepublic Control getControl()
May return null
if the control
has not been created yet.
null
public void dispose()
public void activated()
public void deactivated()
public void becomesVisible()
public void becomesHidden()
public IMemoryBlock getMemoryBlock()
public String getRenderingId()
IMemoryRenderingType
public void addPropertyChangeListener(IPropertyChangeListener listener)
listener
- a property change listenerpublic void removePropertyChangeListener(IPropertyChangeListener listener)
listener
- a property change listenerpublic Image getImage()
public String getLabel()
|
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.