public interface Perspective extends ExtensionImplementation, com.softwareag.cis.plugin.interfaces.Component
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
rcs_id |
Modifier and Type | Method and Description |
---|---|
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
|
getExtension, getPlugIn, popContextClassLoader, pushContextClassLoader, setExtension
static final java.lang.String rcs_id
void setWorkplaceContext(WorkplaceContext wc)
wc
- java.lang.String getTitle()
java.lang.String getImageURL()
com.softwareag.cis.server.util.ICONLISTInfo getToolbar()
java.lang.String getLogoImageURL()
boolean supportsViews()
java.lang.String getViewLabel()
java.util.List getViewValues()
java.lang.String getView()
void setView(java.lang.String view)
view
- java.lang.String getWorkplaceDefaultLayout()
void addTopic(Topic topic)
topic
- java.util.List getTopics()
boolean containsTopic(Topic topic)
topic
- void setSelectedTopic(Topic topic)
topic
- Topic getSelectedTopic()
void reactOnSwitchSelectedPerspective(Perspective oldPerspective, Perspective newPerspective)
oldPerspective
- the perspective which was visible before, null if nonenewPerspective
- the perspective to become visibleboolean isSingeClickable()
java.lang.String getSingleClickMethodName()
boolean hasTopicTree()
boolean isVisible(WorkplaceContext wc)
wc
- The WorkplaceContext.boolean requiresInitialCallReactOnSwitchSelectedPerspective(ApplicationContext ac)
reactOnSwitchSelectedPerspective
is called
on user selection only. Use this method to indicate that your perspective
needs to have that notification callback also on user loginac
- ApplicationContext instancereactOnSwitchSelectedPerspective
on user login otherwise false