com.softwareag.cis.plugin.extpt
Interface Perspective

All Superinterfaces:
com.softwareag.cis.plugin.interfaces.Component, ExtensionImplementation
All Known Implementing Classes:
AbstractPerspective, PlugInPerspective

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


Field Summary
static java.lang.String rcs_id
           
 
Method Summary
 void addTopic(Topic topic)
          Add topic to perspective (internal usage only)
 boolean containsTopic(Topic topic)
          Test whether given topic belongs to this perspective
 java.lang.String getImageURL()
          Get URL of 16x16 icon representing perspective
 java.lang.String getLogoImageURL()
          Get URL of logo or bitmap representing perspective
 Topic getSelectedTopic()
          Obtain topic selected for this perspective
 java.lang.String getSingleClickMethodName()
           
 java.lang.String getTitle()
          Get localized name or title of perspective
 com.softwareag.cis.server.util.ICONLISTInfo getToolbar()
          Get description of commands in toolbar - icons should have size of 24x24 pixels
 java.util.List getTopics()
          Get list of topics associated with perspective
 java.lang.String getView()
          Get current view for this perspective
 java.lang.String getViewLabel()
          Get label for listbox allowing to select view
 java.util.List getViewValues()
          Get valid values for selecting a view
 java.lang.String getWorkplaceDefaultLayout()
          Get layout to be displayed on workplace by default if perspective selected
 boolean hasTopicTree()
          A topic may provide for a tree (eg. for adavanced navigation).
 boolean isSingeClickable()
          Defines if the the perspectiv has no topic and in that business case when a perspective is selected an method should be used.
 boolean isVisible(WorkplaceContext wc)
          Check whether given perspective should be visible within the passed WorkplaceContext.
 void reactOnSwitchSelectedPerspective(Perspective oldPerspective, Perspective newPerspective)
          Notify perspective about change of visible perspective
 boolean requiresInitialCallReactOnSwitchSelectedPerspective(ApplicationContext ac)
          By default method reactOnSwitchSelectedPerspective is called on user selection only.
 void setSelectedTopic(Topic topic)
          Store selected topic for perspective (internal usage only)
 void setView(java.lang.String view)
          Pass selected view to perspective
 void setWorkplaceContext(WorkplaceContext wc)
          Initialize this Perspective - the WorkplaceContext is passed for potential callbacks
 boolean supportsViews()
          Check whether this Perspective supports a view selection list box
 
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

setWorkplaceContext

void setWorkplaceContext(WorkplaceContext wc)
Initialize this Perspective - the WorkplaceContext is passed for potential callbacks

Parameters:
wc -

getTitle

java.lang.String getTitle()
Get localized name or title of perspective

Returns:
the name or title of perspective

getImageURL

java.lang.String getImageURL()
Get URL of 16x16 icon representing perspective

Returns:
icon URL, may be null

getToolbar

com.softwareag.cis.server.util.ICONLISTInfo getToolbar()
Get description of commands in toolbar - icons should have size of 24x24 pixels

Returns:
description of

getLogoImageURL

java.lang.String getLogoImageURL()
Get URL of logo or bitmap representing perspective

Returns:
the URL, may be null

supportsViews

boolean supportsViews()
Check whether this Perspective supports a view selection list box


getViewLabel

java.lang.String getViewLabel()
Get label for listbox allowing to select view

Returns:
the localized label

getViewValues

java.util.List getViewValues()
Get valid values for selecting a view

Returns:
the list of strings representing the available views

getView

java.lang.String getView()
Get current view for this perspective


setView

void setView(java.lang.String view)
Pass selected view to perspective

Parameters:
view -

getWorkplaceDefaultLayout

java.lang.String getWorkplaceDefaultLayout()
Get layout to be displayed on workplace by default if perspective selected

Returns:
the name of the layout to be displayed

addTopic

void addTopic(Topic topic)
Add topic to perspective (internal usage only)

Parameters:
topic -

getTopics

java.util.List getTopics()
Get list of topics associated with perspective

Returns:
the List of Topic objects

containsTopic

boolean containsTopic(Topic topic)
Test whether given topic belongs to this perspective

Parameters:
topic -
Returns:
true if topic belongs to perspective

setSelectedTopic

void setSelectedTopic(Topic topic)
Store selected topic for perspective (internal usage only)

Parameters:
topic -

getSelectedTopic

Topic getSelectedTopic()
Obtain topic selected for this perspective

Returns:
the selected topic for this perspective

reactOnSwitchSelectedPerspective

void reactOnSwitchSelectedPerspective(Perspective oldPerspective,
                                      Perspective newPerspective)
Notify perspective about change of visible perspective

Parameters:
oldPerspective - the perspective which was visible before, null if none
newPerspective - the perspective to become visible

isSingeClickable

boolean isSingeClickable()
Defines if the the perspectiv has no topic and in that business case when a perspective is selected an method should be used. It's recomended that this method is used with a method getSingleClickMethodName() in creation the DLMenuTopItem.

Returns:
true if it is single clickable

getSingleClickMethodName

java.lang.String getSingleClickMethodName()
Returns:
the method name that should be called if the perspective is singleClickable; Note The implementationa of this method should be in DLHeaderAdapter class.

hasTopicTree

boolean hasTopicTree()
A topic may provide for a tree (eg. for adavanced navigation).

Returns:
true if topic provides for a tree false otherwise

isVisible

boolean isVisible(WorkplaceContext wc)
Check whether given perspective should be visible within the passed WorkplaceContext.

Parameters:
wc - The WorkplaceContext.
Returns:
true if the perspective should be visible.

requiresInitialCallReactOnSwitchSelectedPerspective

boolean requiresInitialCallReactOnSwitchSelectedPerspective(ApplicationContext ac)
By default method reactOnSwitchSelectedPerspective is called on user selection only. Use this method to indicate that your perspective needs to have that notification callback also on user login

Parameters:
ac - ApplicationContext instance
Returns:
true to be called with reactOnSwitchSelectedPerspective on user login otherwise false