public class WorkplaceEventListener
extends java.lang.Object
implements com.softwareag.cis.workplace.IMFWorkplaceEventListener2
Modifier and Type | Class and Description |
---|---|
class |
WorkplaceEventListener.ClosePageCommand |
Constructor and Description |
---|
WorkplaceEventListener(com.softwareag.cis.workplace.MFWorkplaceAdapter workplaceAdapter) |
Modifier and Type | Method and Description |
---|---|
static void |
addAdapterForExplicitUpdate(com.softwareag.cis.server.Adapter adapter)
Add adapter in adapters for update in session context
|
static boolean |
allowCloseAllActivities(com.softwareag.cis.workplace.IMFWorkplace wp,
com.softwareag.cis.server.util.ICommand cmd)
Execute given command if allowed to close all activities
|
static boolean |
executeIfCurrentActivityAllowedToLooseFocus(com.softwareag.cis.workplace.IMFWorkplace wp,
com.softwareag.cis.server.util.ICommand cmd)
Execute given command if current activity may be closed or we may switch to another activity
|
static com.softwareag.cis.workplace.IMFWorkplaceActivity |
getActivity(com.softwareag.cis.workplace.IMFWorkplace wp,
int selectedActivity)
The CIS framework provides for multiple activivities running in parallel This function obtains the visible activity at the
given position.
|
static com.softwareag.cis.workplace.IMFWorkplaceActivity |
getCurrentActivity(com.softwareag.cis.workplace.IMFWorkplace wp)
The CIS framework provides for multiple activivities running in parallel This function obtains the visible activity
|
boolean |
reactOnAddPageToWorkplace(com.softwareag.cis.workplace.IMFWorkplace wp,
com.softwareag.cis.workplace.IMFWorkplaceActivity actOld,
com.softwareag.cis.workplace.IMFWorkplaceActivity actNew)
This method is called if a workplace activity is to be started.
|
boolean |
reactOnCloseAllWindowsRequest(com.softwareag.cis.workplace.IMFWorkplace wp,
java.lang.String[] subSessionIds)
CIS Workplace framework provides for a "close all windows" icon within the workplace header.
|
boolean |
reactOnCloseWindowRequest(com.softwareag.cis.workplace.IMFWorkplace workplace,
int selectedActivity)
CIS Workplace framework provides for a "close window" icon within the activity button.
|
void |
reactOnContextMenuRequest(com.softwareag.cis.workplace.IMFWorkplace workplace,
com.softwareag.cis.workplace.MFWorkplaceTopic selectedTopic,
com.softwareag.cis.workplace.MFWorkplaceTreeNodeGeneral clickedNode,
com.softwareag.cis.workplace.MFWorkplaceTreeNodeGeneral[] selectedNodes)
Method is called if the user clicks a tree item with the right mouse button.
|
void |
reactOnContextMenuRequestFunctionTree(com.softwareag.cis.workplace.IMFWorkplace workplace,
com.softwareag.cis.workplace.MFWorkplaceTopic selectedTopic)
Method is called if the user clicks into the free available space of the function tree with the right mouse button.
|
void |
reactOnContextMenuRequestMFTopic(com.softwareag.cis.workplace.IMFWorkplace workplace,
com.softwareag.cis.workplace.MFWorkplaceTopic selectedTopic) |
void |
reactOnDrop(com.softwareag.cis.workplace.IMFWorkplace workplace,
com.softwareag.cis.workplace.MFWorkplaceTopic selectedTopic,
com.softwareag.cis.workplace.MFWorkplaceTreeNodeGeneral target,
com.softwareag.cis.workplace.MFWorkplaceTreeNodeGeneral[] draggedItem)
There are several different "drop events".
|
void |
reactOnDropDustbin(com.softwareag.cis.workplace.IMFWorkplace workplace,
java.lang.String dropInfo)
This method is called if the user drags an icon (e.g. a favourite) or a function tree item to the dustbin and drops it there.
|
void |
reactOnDropGeneric(com.softwareag.cis.workplace.IMFWorkplace workplace,
com.softwareag.cis.workplace.MFWorkplaceTopic selectedTopic,
com.softwareag.cis.workplace.MFWorkplaceTreeNodeGeneral target,
java.lang.String dropInfo)
This method is called if the user drags an icon over a function tree item and drops it there.
|
boolean |
reactOnMaxNumberOfWorkplaceActivitiesReached(com.softwareag.cis.workplace.IMFWorkplace wp,
java.lang.String pageFileName,
java.lang.String pageTitle)
Method is called if the maximum number of open activities has been reached and the user tries to open next activity.
|
void |
reactOnPopupMenuClosedByUser(com.softwareag.cis.workplace.IMFWorkplace wp)
React on popup menu being closed
|
void |
reactOnRemovePageFromWorkplace(com.softwareag.cis.workplace.IMFWorkplace wp,
com.softwareag.cis.workplace.IMFWorkplaceActivity actOld)
This method is called after removing a workplace activity
(i.e. after executing IMFWorkplace.removePageFromWorkplace).
|
boolean |
reactOnSwitchSelectedActivity(com.softwareag.cis.workplace.IMFWorkplace wp,
com.softwareag.cis.workplace.IMFWorkplaceActivity currentActivity,
com.softwareag.cis.workplace.IMFWorkplaceActivity newActivity)
Within the header of the CIS Workplace framework user can switch between workplace activities.
|
boolean |
reactOnSwitchSelectedTopic(com.softwareag.cis.workplace.IMFWorkplace wp,
com.softwareag.cis.workplace.MFWorkplaceTopic currentTopic,
com.softwareag.cis.workplace.MFWorkplaceTopic newTopic)
Book keeping for scenario when switching topic Method is called if the user clicks onto a button within the (left) workplace
menu frame.
|
static void |
removeFromExplicitUpdate(com.softwareag.cis.server.Adapter adapter)
Remove adapter in adapters for update in session context
|
static void |
updateWorkplace(com.softwareag.cis.workplace.MFWorkplaceAdapter workplaceAdapter)
Refreshes some adapters and causes some frame targets to refresh their data content
|
public WorkplaceEventListener(com.softwareag.cis.workplace.MFWorkplaceAdapter workplaceAdapter)
public static void addAdapterForExplicitUpdate(com.softwareag.cis.server.Adapter adapter)
public static void removeFromExplicitUpdate(com.softwareag.cis.server.Adapter adapter)
public void reactOnContextMenuRequest(com.softwareag.cis.workplace.IMFWorkplace workplace, com.softwareag.cis.workplace.MFWorkplaceTopic selectedTopic, com.softwareag.cis.workplace.MFWorkplaceTreeNodeGeneral clickedNode, com.softwareag.cis.workplace.MFWorkplaceTreeNodeGeneral[] selectedNodes)
reactOnContextMenuRequest
in interface com.softwareag.cis.workplace.IMFWorkplaceEventListener
workplace
- reference to the workplace managementselectedTopic
- the currently selected workplace topicclickedNode
- the tree item that received the right mouse clickselectedNodes
- the current selection of the topic treepublic void reactOnContextMenuRequestFunctionTree(com.softwareag.cis.workplace.IMFWorkplace workplace, com.softwareag.cis.workplace.MFWorkplaceTopic selectedTopic)
reactOnContextMenuRequestFunctionTree
in interface com.softwareag.cis.workplace.IMFWorkplaceEventListener
workplace
- reference to the workplace managementselectedTopic
- the currently selected workplace topicpublic void reactOnContextMenuRequestMFTopic(com.softwareag.cis.workplace.IMFWorkplace workplace, com.softwareag.cis.workplace.MFWorkplaceTopic selectedTopic)
reactOnContextMenuRequestMFTopic
in interface com.softwareag.cis.workplace.IMFWorkplaceEventListener
public void reactOnDrop(com.softwareag.cis.workplace.IMFWorkplace workplace, com.softwareag.cis.workplace.MFWorkplaceTopic selectedTopic, com.softwareag.cis.workplace.MFWorkplaceTreeNodeGeneral target, com.softwareag.cis.workplace.MFWorkplaceTreeNodeGeneral[] draggedItem)
reactOnDrop
in interface com.softwareag.cis.workplace.IMFWorkplaceEventListener
workplace
- reference to the workplace managementselectedTopic
- the currently selected workplace topictarget
- the tree item that received the drop eventdraggedItem
- the item that was dragged to the targetpublic void reactOnDropDustbin(com.softwareag.cis.workplace.IMFWorkplace workplace, java.lang.String dropInfo)
reactOnDropDustbin
in interface com.softwareag.cis.workplace.IMFWorkplaceEventListener
workplace
- reference to the workplace managementdropInfo
- the "drop info" of the dragged item. The drop info of a tree item is set dynamically (property "dropInfo" at class
NODEInfo). ICON controls provide for attribute DROPINFO.public void reactOnDropGeneric(com.softwareag.cis.workplace.IMFWorkplace workplace, com.softwareag.cis.workplace.MFWorkplaceTopic selectedTopic, com.softwareag.cis.workplace.MFWorkplaceTreeNodeGeneral target, java.lang.String dropInfo)
reactOnDropGeneric
in interface com.softwareag.cis.workplace.IMFWorkplaceEventListener
workplace
- reference to the workplace managementselectedTopic
- the currently selected workplace topictarget
- the tree item that received the drop eventdropInfo
- the "drop info" of the dragged item. The drop info of a tree item is set dynamically (property "dropInfo" at class
NODEInfo). ICON controls provide for attribute DROPINFO.public boolean reactOnCloseAllWindowsRequest(com.softwareag.cis.workplace.IMFWorkplace wp, java.lang.String[] subSessionIds)
reactOnCloseAllWindowsRequest
in interface com.softwareag.cis.workplace.IMFWorkplaceEventListener
wp
- reference to the workplace managementsubSessionIds
- The subssesion ids of the currently started workplace activities.public boolean reactOnCloseWindowRequest(com.softwareag.cis.workplace.IMFWorkplace workplace, int selectedActivity)
reactOnCloseWindowRequest
in interface com.softwareag.cis.workplace.IMFWorkplaceEventListener
workplace
- reference to the workplace managementselectedActivity
- The activity id which will be closed.public boolean reactOnSwitchSelectedActivity(com.softwareag.cis.workplace.IMFWorkplace wp, com.softwareag.cis.workplace.IMFWorkplaceActivity currentActivity, com.softwareag.cis.workplace.IMFWorkplaceActivity newActivity)
reactOnSwitchSelectedActivity
in interface com.softwareag.cis.workplace.IMFWorkplaceEventListener
wp
- reference to the workplace managementcurrentActivity
- newActivity
- public boolean reactOnSwitchSelectedTopic(com.softwareag.cis.workplace.IMFWorkplace wp, com.softwareag.cis.workplace.MFWorkplaceTopic currentTopic, com.softwareag.cis.workplace.MFWorkplaceTopic newTopic)
reactOnSwitchSelectedTopic
in interface com.softwareag.cis.workplace.IMFWorkplaceEventListener
wp
- is workplace reference to the workplace managementcurrentTopic
- the currently selected workplace topicnewTopic
- the clicked topicpublic void reactOnPopupMenuClosedByUser(com.softwareag.cis.workplace.IMFWorkplace wp)
reactOnPopupMenuClosedByUser
in interface com.softwareag.cis.workplace.IMFWorkplaceEventListener
public static com.softwareag.cis.workplace.IMFWorkplaceActivity getActivity(com.softwareag.cis.workplace.IMFWorkplace wp, int selectedActivity)
wp
- - workplaceselectedActivity
- - positionpublic static com.softwareag.cis.workplace.IMFWorkplaceActivity getCurrentActivity(com.softwareag.cis.workplace.IMFWorkplace wp)
wp
- public static boolean executeIfCurrentActivityAllowedToLooseFocus(com.softwareag.cis.workplace.IMFWorkplace wp, com.softwareag.cis.server.util.ICommand cmd)
public static boolean allowCloseAllActivities(com.softwareag.cis.workplace.IMFWorkplace wp, com.softwareag.cis.server.util.ICommand cmd)
public static void updateWorkplace(com.softwareag.cis.workplace.MFWorkplaceAdapter workplaceAdapter)
public boolean reactOnAddPageToWorkplace(com.softwareag.cis.workplace.IMFWorkplace wp, com.softwareag.cis.workplace.IMFWorkplaceActivity actOld, com.softwareag.cis.workplace.IMFWorkplaceActivity actNew)
reactOnAddPageToWorkplace
in interface com.softwareag.cis.workplace.IMFWorkplaceEventListener2
wp
- reference to the workplace managementactOld
- handle to currently selected workplace activities. May be null!actNew
- handle to activity to start.public void reactOnRemovePageFromWorkplace(com.softwareag.cis.workplace.IMFWorkplace wp, com.softwareag.cis.workplace.IMFWorkplaceActivity actOld)
reactOnRemovePageFromWorkplace
in interface com.softwareag.cis.workplace.IMFWorkplaceEventListener2
wp
- Reference to the workplace managementactOld
- Removed workplace activity.public boolean reactOnMaxNumberOfWorkplaceActivitiesReached(com.softwareag.cis.workplace.IMFWorkplace wp, java.lang.String pageFileName, java.lang.String pageTitle)
reactOnMaxNumberOfWorkplaceActivitiesReached
in interface com.softwareag.cis.workplace.IMFWorkplaceEventListener2
wp
- handle to CIS workplacepageFileName
- URL of the new activity the user wants to startpageTitle
- Display string of the new activity the user wants to start