com.sdm.quasar.client.swing.embedding.services
Class AbstractVisualRepresentationService

java.lang.Object
  com.sdm.quasar.client.core.dialog.AbstractPerChildService
      com.sdm.quasar.client.swing.embedding.services.AbstractVisualRepresentationService

All Implemented Interfaces:

Disposable, Service, SystemInfoProvider, VisualRepresentationService

public abstract class AbstractVisualRepresentationService

extends AbstractPerChildService

implements VisualRepresentationService, SystemInfoProvider

Version:

1.$Revision$

Author:

Thomas Wolf

Constructor Summary

AbstractVisualRepresentationService(DialogControl dialogControl, SubDialogControl subDialogControl, java.lang.String registrationContext)
Creates a new AbstractVisualRepresentationService.

Method Summary

void	clearVisualRepresentation()
void	collectSystemInfo(SystemInfoNode root, SystemInfoOptions options) Builds the system information tree upon local information of the implementor.
void	dispose() Disposes the component.
javax.swing.JComponent	getParentVisualRepresentation()
javax.swing.JComponent	getVisualRepresentation()
void	setVisualRepresentation(javax.swing.JComponent jcomponent)
protected abstract javax.swing.JComponent	visualRepresentationChanged(javax.swing.JComponent oldVisualRepresentation, javax.swing.JComponent newVisualRepresentation)

Methods inherited from class com.sdm.quasar.client.core.dialog.AbstractPerChildService

getDialogControl, getSubDialogControl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractVisualRepresentationService

public AbstractVisualRepresentationService(DialogControl dialogControl,
                                           SubDialogControl subDialogControl,
                                           java.lang.String registrationContext)

Creates a new AbstractVisualRepresentationService.

Parameters:

dialogControl -

subDialogControl -

Method Detail

dispose

public void dispose()
             throws DisposeException

Description copied from interface: Disposable

Disposes the component.

Important:
This method is called by an administrating component and must never be called directly.

The implementation should release any resources or objects allocated and any services registered. Furthermore, this method should be developed carefully to free a maximum of resources even when the system may have become unstable. In case of one or multiple errors, you should collect them in a DisposeException, continue with the execution, and throw it at the end of the method.

Note: The implementation must not return before the component is disposed. Any threads or asynchronous calls started must be completed before this method returns.

Specified by:

dispose in interface Disposable

Throws:

DisposeException - if there was one or more errors while disposing the component.

See Also:

Disposable.dispose()

getParentVisualRepresentation

public javax.swing.JComponent getParentVisualRepresentation()

Specified by:

getParentVisualRepresentation in interface VisualRepresentationService

See Also:

com.sdm.quasar.client.core.embedding.services.VisualRepresentationService#getParentVisualRepresentation()

getVisualRepresentation

public final javax.swing.JComponent getVisualRepresentation()

Specified by:

getVisualRepresentation in interface VisualRepresentationService

See Also:

com.sdm.quasar.client.core.embedding.services.VisualRepresentationService#getVisualRepresentation()

setVisualRepresentation

public final void setVisualRepresentation(javax.swing.JComponent jcomponent)

Specified by:

setVisualRepresentation in interface VisualRepresentationService

See Also:

com.sdm.quasar.client.core.embedding.services.VisualRepresentationService#setVisualRepresentation(javax.swing.JComponent)

clearVisualRepresentation

public void clearVisualRepresentation()

Specified by:

clearVisualRepresentation in interface VisualRepresentationService

See Also:

com.sdm.quasar.client.core.embedding.services.VisualRepresentationService#clearVisualRepresentation()

visualRepresentationChanged

protected abstract javax.swing.JComponent visualRepresentationChanged(javax.swing.JComponent oldVisualRepresentation,
                                                                      javax.swing.JComponent newVisualRepresentation)

collectSystemInfo

public void collectSystemInfo(SystemInfoNode root,
                              SystemInfoOptions options)

Description copied from interface: SystemInfoProvider

Builds the system information tree upon local information of the implementor. The system information tree can be used within development by inspecting the system; so implementors should append their internal state (depending on the details settings within SystemInfoOptions). The information can be appended to the tree by adding new child SystemInformationNodes to the root node given using the SystemInfoNode.createChild(String) method and by setting information attributes the these nodes or the given root node.

Specified by:

collectSystemInfo in interface SystemInfoProvider

Parameters:

root - the SystemInfoNode to add information to (guaranteed to be not null)

options - contains additional options, that might influence the amount of information added to the tree (guaranteed to be not null)

See Also:

SystemInfoProvider.collectSystemInfo(com.sdm.quasar.client.core.common.sysinfo.SystemInfoNode, com.sdm.quasar.client.core.common.sysinfo.SystemInfoOptions)