com.softwareag.cis.plugin.extpt

Interface Topic

All Superinterfaces:

com.softwareag.cis.plugin.interfaces.Component, ExtensionImplementation

All Known Implementing Classes:

AbstractTopic, PlugInTopic

public interface Topic
extends ExtensionImplementation, com.softwareag.cis.plugin.interfaces.Component

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	rcs_id

Method Summary

Modifier and Type	Method and Description
boolean	createWorkplaceTopic() Create the WorkplaceTopic object for this topic
java.util.List	getCommands() Used for drop down menu for topic.
com.softwareag.cis.server.util.TREECollection	getContextMenu() Obtain a context menu when selecting right mouse button in free area of workplace topic
java.lang.String	getImageURL() Get image URL for topic
java.lang.String	getPageAdapterClass() Get the adapter class of page to be opened
java.lang.String	getPageURL() Get page URL for topic
Perspective	getPerspective() Get perspective this topic is part of
java.lang.String	getTitle() Get localized title of topic
com.softwareag.cis.workplace.MFWorkplaceTopic	getWorkplaceTopic() Obtain the WorkplaceTopic object for this topic
void	reactOnPopupMenuClosedByUser() React on closing context menu opened within topic
void	reactOnSwitchSelectedTopic(Topic oldTopic, Topic newTopic) React on topic change
void	reactOnSwitchSelectedTopicWithTopicCommand(Topic oldTopic, Topic newTopic, Command topicCommand) React on topic change
void	setWorkplaceContext(WorkplaceContext wc) Initialize this topic - the WorkplaceContext is passed for potential callbacks

Methods inherited from interface com.softwareag.cis.plugin.registry.ExtensionImplementation

getExtension, getPlugIn, popContextClassLoader, pushContextClassLoader, setExtension

Methods inherited from interface com.softwareag.cis.plugin.interfaces.Component

getId, isEnabled, isVisible, setEnabled, setVisible

Field Detail

rcs_id

static final java.lang.String rcs_id

See Also:

Constant Field Values

Method Detail

getCommands

java.util.List getCommands()

Used for drop down menu for topic.

setWorkplaceContext

void setWorkplaceContext(WorkplaceContext wc)

Initialize this topic - the WorkplaceContext is passed for potential callbacks

Parameters:

wc -

createWorkplaceTopic

boolean createWorkplaceTopic()
                      throws java.lang.Exception

Create the WorkplaceTopic object for this topic

Returns:

true if the tree has been newly created, false if the tree has been reused from a previous WorkplaceTopic created for a extension implementing this interface

Throws:

java.lang.Exception

getWorkplaceTopic

com.softwareag.cis.workplace.MFWorkplaceTopic getWorkplaceTopic()

Obtain the WorkplaceTopic object for this topic

Returns:

the WorkplaceTopic

getTitle

java.lang.String getTitle()

Get localized title of topic

Returns:

the localized title

getImageURL

java.lang.String getImageURL()

Get image URL for topic

Returns:

the URL or null, if no image to be provided

getPerspective

Perspective getPerspective()

Get perspective this topic is part of

Returns:

the Perspective

reactOnSwitchSelectedTopic

void reactOnSwitchSelectedTopic(Topic oldTopic,
                                Topic newTopic)

React on topic change

Parameters:

oldTopic -

newTopic -

reactOnSwitchSelectedTopicWithTopicCommand

void reactOnSwitchSelectedTopicWithTopicCommand(Topic oldTopic,
                                                Topic newTopic,
                                                Command topicCommand)

React on topic change

Parameters:

oldTopic -

newTopic -

reactOnPopupMenuClosedByUser

void reactOnPopupMenuClosedByUser()

React on closing context menu opened within topic

getContextMenu

com.softwareag.cis.server.util.TREECollection getContextMenu()

Obtain a context menu when selecting right mouse button in free area of workplace topic

Returns:

the TREECollection describing the context menu or null if no context menu is to be shown

getPageURL

java.lang.String getPageURL()

Get page URL for topic

Returns:

the URL or null, if no page to be provided

getPageAdapterClass

java.lang.String getPageAdapterClass()

Get the adapter class of page to be opened

Returns:

adapter class name