How to Use Web Dynpro Popup Menus

Transcription

1 How to Use Web Dynpro Popup Menus Bertram Ganz and Daniel Wirbser SAP AG, NW ESI Foundation UI Overview This sample application demonstrates the usage of Web Dynpro popup menus that come with SAP NetWeaver 2004s. You will learn how to add a popup menu to a Tray UI element, how to declare menu item events, and how to disable or enable menu action items by programmatically disabling or enabling the associated action objects within action event handlers. The sample application also shows popup menus in table cell editors. To select the contained menu items without changing the table s lead selection, the special table selection mode nw04plus combined with parameter mapping is applied. Besides the static definition of popup menus at design time, this tutorial demonstrates how to add popup menus dynamically at runtime by modifying the view layout within the wddomodifyview() controller hook method. Contents 1. Introduction 2. Creating Component and Context 3. Designing the View Layout using Popup Menus 4. Implementing Action Event Handlers 5. Applying the Table Selection Behavior nw04plus 6. Dynamically Adding Popup Menus to the View Layout 7. Related Content Keywords Web Dynpro, Menu, Popup menu, IWDMenu, IWDMenuActionItem, IWDMenuCheckBox, IWDMenuRadioButton, IWDMenuSeparator, Web Dynpro Table, dynamic programming, dynamic UI modification, end user UI customizing, action, action object, parameter mapping, table selection Behavior, compatibiltymode 1. Introduction Demo Application Sshowing Popup Menus The application scenario will demonstrates the following popup menu functions:... The end user is able to customize the Web Dynpro view on the UI using popup menus in both trays (product detail tray, product table tray): 1. Swap (move down or move down) the position of both trays on the UI 2. Delete one row in the table with a popup menu item of a product cell editor (Product ID column) without implicitly changing the table s lead selection. 3. Display product details with a popup menu item of a product cell editor (Product ID column) without implicitly changing the table s lead selection. 4. Hide the product table tray and show it again. 5. The popup menu of the product detail tray is dynamically added at runtime within the wddomodifyview() hook method of the view controller. How to use Popup Menus in Web Dynpro Applications 1

2 Figure 1: Screenshots of demo application demonstrating popup menus How to use Popup Menus in Web Dynpro Applications 2

3 2. Creating Component and Context Create a New Development Component In SAP NetWeaver Developer Studio open the Development Component Perspective to create a new DC. Create a new Web Dynpro DC: In window Local DCs MyComponents select Create New DC, enter sap.com as vendorname, wd/popupmenus as name of the DC and Web Dynpro as DC type. Create a New Web Dynpro Application and Web Dynpro Component Select Applications Create Application and enter PopupMenuApp as name, com.sap.tc.wd.samples.menus as package. Select Create a new component and enter the following values (see table). Input field ComponentName ComponentPackage Window Name Window Package View Name View Package Value PopupMenuComp com.sap.tc.wd.samples.menus PopupMenuWindow com.sap.tc.wd.samples.menus PopupMenuView com.sap.tc.wd.samples.menus Define the Controller Context In the view PopupMenuView create the following context elements: Node/Attribute Name Type Java Data Type Products Value Node (cardinality: 0..n) Details Value Attribute string Name Value Attribute string Price Value Attribute string ProductId Value Attribute string Quantity Value Attribute integer UIState Value Node (cardinality: 1..1 selection cardinality: 1..1) DoSwapTrays Value Attribute boolean MenuItemSelected Value Attribute boolean ProductTrayVisibility Value Attribute Visibility ProductDetail Value Attribute string How to use Popup Menus in Web Dynpro Applications 3

4 Programmatically Populate Context with Sample Data To fill the context with some sample date, the following coding in wddoinit() will be used: javadoc:wddoinit() /** Hook method called to initialize controller. */ public void wddoinit() wddoinit() // ======== Popuplate context node 'Products' ==================== // fill product table with some data List products = new ArrayList(); IPrivatePopupMenuView.IProductsElement product = wdcontext.createproductselement(); product.setname("product 1"); product.setprice("89,90"); product.setproductid("pp-1020"); product.setquantity(850); product.setdetails("detailed description of product 1"); products.add(product); product = wdcontext.createproductselement(); product.setname("product 2"); product.setprice("849,00"); product.setproductid("prd-4711"); product.setquantity(12); product.setdetails("detailed description of product 2"); products.add(product); product = wdcontext.createproductselement(); product.setname("product 3"); product.setprice("0,89"); product.setproductid("zr-0124"); product.setquantity(1000); product.setdetails("detailed description of product 3"); products.add(product); product = wdcontext.createproductselement(); product.setname("product 4"); product.setprice("1,15"); product.setproductid("zr-1454"); product.setquantity(1000); product.setdetails("detailed description of product 4"); products.add(product); // add collection of node elements to context value node wdcontext.nodeproducts().bind(products); // ======== Initialize context attribute 'DoSwapTrays' ==================== // set product table visible and show messages wdcontext.currentuistateelement().setdoswaptrays(false); // ======== Disable certain action objects ==================== wdthis.wdgetmovedownaction().setenabled(false); wdthis.wdgetshowproducttrayaction().setenabled(false); How to use Popup Menus in Web Dynpro Applications 4

5 3. Designing the View Layout Using Popup Menus Menus in general can be used in a MenuBar UI element or within certain UI elements like trays or table cell editors as popup menus: The popup menu is used to group actions in a space-saving way. After a user action the menu is opened according to the UI element to which it is assigned. A MenuBar and a popup menu consist of the following elements: Submenus for hierarchical menu structures, defined as a menu. Different menu items which can be defined as the following UI elements: MenuActionItem, MenuRadioButton, MenuCheckBox, MenuSeparator. The MenuSeparator element adds a separator between two menu items and thus provides a structure to the menu items. Please note that popup menus do not fulfill real context menu functions like populating menus on demand or adapting them to the UI context in which they are opened. Insert a Popup Menu in a Tray UI Element Within the View Designer (select PopupMenuView Layout) implement the following view layout: To use a popup menu you have to select the UI element you want to use for a popup menu (e. g. tray) and select Insert PopupMenu. In this demo application select the ProductTableTray Tray UI element an insert a PopupMenu with id PopupMenuTableTray. Insert the following three menu items by selecting Insert Item. Bind the onaction event of the two MenuActionItem UI elements to new actions. Defining a new action is done by pressing the utmost right button [ ] in the line onaction: How to use Popup Menus in Web Dynpro Applications 5

6 ID Type Event.. onaction Action Text menup MenuActionItem MoveUp Move Up mendown MenuActionItem MoveDown Move Down menseparator MenuSeparator - - menhide MenuActionItem HideProductTray Hide Tray The text property of each menu action item must not be explicitly set as it is retrieved from the associated action object at runtime. For this reason the texts must be defined on action level (action texts) at design time. For the definition of a popup menu in the table you have to select the TableCellEditor of the column you want to provide with a popup menu. Select the context menu item ProductId_editor Insert Menu to insert a menu with ID MenuProductTable. Define the following menu items in the menu UI element MenuProductTable. ID Type Event.. onaction Action Text menshowdetails MenuActionItem ShowProductDetails Show Details mensepprod MenuSeparator - - mendeleteproduct MenuActionItem DeleteProduct Delete Supported UI Elements for Popup Menus List of UI elements carrying a menu: Image, LinkToAction, LinkToURL, ProgressIndicator, TextView, Tray, TreeItem, NodeType Out of this set of menu-aggregating UI elements the following ones can be used as table cell editors: Image, LinkToAction, LinkToURL, ProgressIndicator, TextView How to use Popup Menus in Web Dynpro Applications 6

7 4. Applying the Table Selection Behavior nw04plus When using popup menus in table cell editors we want to avoid an implicit lead selection change. It is quite cumbersome for the user when the selected table line is always moved to the table line, where the popup menu action item was selected. Instead the table s lead selection should keep unaffected for all selected menu items: Such a behavior can be achieved by setting the table property compatibilitymode to nw04plus in combination with implementing a parameter mapping relation. The parameter mapping relation must be implemented to transfer the event parameter nodeelement of a MenuActionItem UI element to a corresponding parameter in the action event handler. With this mechanism a reference to the clicked node element (product in table line) is automatically passed to the action event handler by the Web Dynpro runtime. The lead selection no longer needs to be implicitly changed or accessed for this purpose. Setting the Product Table Property compatibilitymode=nw04plus In a first declarative step, we set the table property compatibilitymode as nw04plus: Select perspective view Layout of the PopupMenuView In the Outline select the Table UI element with id ProductTable Set the property compatibilitymode as nw04plus Define the Action Parameter product We then add a the parameter product of type IProductsElement to the actions ShowProductDetails and DeleteProduct. Select action ShowProductDetails. Define a new action parameter by pressing button New. parameter name: product. parameter type: the parameter type must be defined as IPrivatePopupMenuView.IProductsElement (See following screenshots). You must mark the check box Adapt event handler parameter so that the new action parameter is also added to the related action event handler. Additionally add the same parameter product to the action DeleteProduct and its associated action event handler. How to use Popup Menus in Web Dynpro Applications 7

8 After this step the signature of the generated action event handler onactiondeleteproduct() looks like this: javadoc:onactiondeleteproduct(serverevent) public void onactiondeleteproduct( com.sap.tc.webdynpro.progmodel.api.iwdcustomevent wdevent, com.sap.tc.wd.samples.menus.wdp.iprivatepopupmenuview.iproductselement product ) //@@begin onactiondeleteproduct(serverevent)... Implement Parameter Mapping in wddomodifyview() The controller code, which implements the required parameter mapping, is as follows: public static void wddomodifyview( IPrivatePopupMenuView wdthis, IPrivatePopupMenuView.IContextNode wdcontext, com.sap.tc.webdynpro.progmodel.api.iwdview view, boolean firsttime) //@@begin wddomodifyview if (firsttime) // === Apply Parameter Mapping to use compatibilitymode='nw04plus' ===== // Apply compatibilitymode feature for omitting a second server roundtrip // when clicking a menu action item in a table cell editor. As a consequence // the table's lead selection is not changed when selecting a menu action // item. Map UI element event parameter 'nodeelement' to action (event // handler) parameter 'product' (parameter mapping). IWDMenuActionItem menuactionitem = (IWDMenuActionItem) view.getelement("menshowdetails"); menuactionitem.mappingofonaction().addsourcemapping("nodeelement", "product"); menuactionitem = (IWDMenuActionItem) view.getelement("mendeleteproduct"); menuactionitem.mappingofonaction().addsourcemapping("nodeelement", "product"); How to use Popup Menus in Web Dynpro Applications 8

9 5. Implementing Action Event Handlers The next step is to implement the application logic to handle the events in the previously defined actions. The following actions and action event handlers are declared in the view controller of view PopupMenuView: Action Action Text Action Event Handler DeleteProduct Delete onactiondeleteproduct HideProductTray Hide Tray onactionhideproducttray ShowProductTray Show Product Tray onactionshowproducttray MoveDown Move Down onactionmovedown MoveUp Move Up onactionmoveup OnToggle Some Toggle Action onactiontoggle ShowProductDetails Show Details onactionshowproductdetails Implement Controller Code The following code blocks comprise the implementation of the different action event handlers. They are processed by the Web Dynpro Java Runtime when the user has selected a popup menu item on the UI. onactiondeleteproduct () will be called to delete one element in the context node Products. Based on the implemented parameter mapping relation we can access the clicked node element with the action event parameter product. onactionmoveup() and onactionmovedown() will be called to set the context attribute UIState.DoSwapTrays to true and to adapt the state of the action objects MoveUpAction and MoveDownAction. Later, we will swap the order of both trays within the wddomodifyview() hook method. onactionhideproducttray and onactionshowproducttray will be called to set the context attribute ProductTrayVisibility (controls the visibility of the tray with the product table) and to adapt the state of action object ShowProductTrayAction. onactionshowproductdetails will be called to show further product details as TextView UI element in the product detail tray. A reference to the clicked node element is passed by the Web Dynpro Runtime with the action event parameter product. Please notice how the state (disabled or enabled) of the MenuActionItem UI element is implicitly managed by disabling or enabling the action objects to which its onaction event is bound. Based on the event-to-action binding mechanism the Web Dynpro Runtime automatically renders a UI element as disabled in case its event is bound to a disabled action object. This implicit action-object-based disabling/enabling of menu items is not applied for the UI elements MenuCheckBox and MenuRadioButton. They keep enabled for disabled actions. How to use Popup Menus in Web Dynpro Applications 9

10 javadoc:onactiondeleteproduct(serverevent) public void onactiondeleteproduct( com.sap.tc.webdynpro.progmodel.api.iwdcustomevent wdevent, com.sap.tc.wd.samples.menus.wdp.iprivatepopupmenuview.iproductselement product ) //@@begin onactiondeleteproduct(serverevent) String productid = product.getproductid(); wdcontext.nodeproducts().removeelement(product); wdcomponentapi.getmessagemanager().reportsuccess("product " + productid + " was sucessfully deleted."); wdcontext.currentcontextelement().setproductdetail(""); //@@begin javadoc:onactionshowproductdetails(serverevent) //@@en d public void onactionshowproductdetails( com.sap.tc.webdynpro.progmodel.api.iwdcustomevent wdevent, com.sap.tc.wd.samples.menus.wdp.iprivatepopupmenuview.iproductselement product) //@@begin onactionshowproductdetails(serverevent) wdcontext.currentcontextelement().setproductdetail( "Details for " + product.getproductid() + ": " + product.getdetails()); //@@begin javadoc:onactionhideproducttray(serverevent) public void onactionhideproducttray( com.sap.tc.webdynpro.progmodel.api.iwdcustomevent wdevent ) //@@begin onactionhideproducttray(serverevent) wdcontext.currentuistateelement().setproducttrayvisibility(wdvisibility.none); wdthis.wdgetshowproducttrayaction().setenabled(true); wdcontext.currentcontextelement().setproductdetail(""); //@@begin javadoc:onactionshowproducttray(serverevent) //@@en d public void onactionshowproducttray( com.sap.tc.webdynpro.progmodel.api.iwdcustomevent wdevent ) //@@begin onactionshowproducttray(serverevent) wdcontext.currentuistateelement().setproducttrayvisibility( WDVisibility.VISIBLE); wdthis.wdgetshowproducttrayaction().setenabled(false); //@@begin javadoc:onactionmoveup(serverevent) public void onactionmoveup( com.sap.tc.webdynpro.progmodel.api.iwdcustomevent wdevent ) //@@begin onactionmoveup(serverevent) wdthis.wdgetmoveupaction().setenabled(false); wdthis.wdgetmovedownaction().setenabled(true); How to use Popup Menus in Web Dynpro Applications 10

11 wdcontext.currentuistateelement().setdoswaptrays(true); javadoc:onactionmovedown(serverevent) public void onactionmovedown( com.sap.tc.webdynpro.progmodel.api.iwdcustomevent wdevent ) //@@begin onactionmovedown(serverevent) wdthis.wdgetmoveupaction().setenabled(true); wdthis.wdgetmovedownaction().setenabled(false); wdcontext.currentuistateelement().setdoswaptrays(true); 6. Dynamically Adding Menus to the View Layout Swap Tray UI Element Containers in wddomodifyview() RootUIElementContainer swapchildren(1,2) Within the action event handlers onactionmovedown() and onactionmoveup()we set the context attribute UIState.DoSwapTrays to true. //@@begin javadoc:onactionmovedown(serverevent) public void onactionmovedown( com.sap.tc.webdynpro.progmodel.api.iwdcustomevent wdevent ) //@@begin onactionmovedown(serverevent) wdthis.wdgetmoveupaction().setenabled(true); wdthis.wdgetmovedownaction().setenabled(false); wdcontext.currentuistateelement().setdoswaptrays(true); Within the wddomodifyview() hook method we can then access this context attribute in order to swap the position of both Tray UI element containers. This can be done by calling the method swapchildren(1,2) which is implemented by all UI element containers of type IWDUIElementContainer. The RootContainerUIElement is of type IWDTransparentContainer How to use Popup Menus in Web Dynpro Applications 11

12 which extends the IWDUIElementContainer interface. The integer values 1 and 2 are based on the fact, that the UI Element HeaderTextView as the first child of the RootContainerUIElement is at position 0. public static void wddomodifyview( IPrivatePopupMenuView wdthis, IPrivatePopupMenuView.IContextNode wdcontext, com.sap.tc.webdynpro.progmodel.api.iwdview view, boolean firsttime) //@@begin wddomodifyview if (firsttime)... else if (wdcontext.currentuistateelement().getdoswaptrays()) // Swap Trays if action 'MoveUp' or 'MoveDown' was triggered on the UI IWDTransparentContainer rootuielement = (IWDTransparentContainer) (IWDTransparentContainer) view.getrootelement(); rootuielement.swapchildren(1, 2); wdcontext.currentuistateelement().setdoswaptrays(false); Dynamically Add a Popup Menu in wddomodifyview() If you want to add popup menus to the view layout at runtime you have to apply dynamic view modification. The related APIs are IWDMenu for menus, IWDMenuActionItems for items in menus, IWDMenuCheckBox for checkboxes im menus and IWDMenuSeparator for horizontal menu separators. The following controller code demonstrates how to create a menu in the wddomodifyview() hook method. Three menu items are added to a new popup menu which is associated with the Tray UI element with id ProductDetailTray by invoking traymsg.setpopupmenu(popupmenu). The first menu item is of type IWDMenuActionItem. Its onaction event is bound to the action ShowProductTrayAction which displays the hidden product detail tray. The second menu item is a UI element of type IWDMenuSeparator. The last one is a checkbox menu item of type IWDMenuCheckBox. The context attribute menuitemselected of type boolean stores the state of this checkbox. The checked property of the menu check box is dynamically bound to this context attribute. public static void wddomodifyview( IPrivatePopupMenuView wdthis, IPrivatePopupMenuView.IContextNode wdcontext, com.sap.tc.webdynpro.progmodel.api.iwdview view, boolean firsttime) //@@begin wddomodifyview if (firsttime) // === Apply Parameter Mapping to use compatibilitymode='nw04plus' =====... // === Dynamically add popup menu to Message Tray ========================= // create IWDMenu object IWDTray traymsg = (IWDTray) view.getelement("productdetailtray"); IWDMenu popupmenu = (IWDMenu) view.createelement(iwdmenu.class, null); traymsg.setpopupmenu(popupmenu); How to use Popup Menus in Web Dynpro Applications 12

13 // add menu action item (IWDMenuActionItem) menuactionitem = (IWDMenuActionItem) view.createelement(iwdmenuactionitem.class, null); menuactionitem.setonaction(wdthis.wdgetshowproducttrayaction()); popupmenu.additem(menuactionitem); // add menu separator IWDMenuSeparator menuseparator = (IWDMenuSeparator) view.createelement(iwdmenuseparator.class, null); popupmenu.additem(menuseparator); // add menu check box (IWDMenuCheckBox) IWDMenuCheckBox menucheckbox = (IWDMenuCheckBox) view.createelement(iwdmenucheckbox.class, null); menucheckbox.setontoggle(wdthis.wdgetontoggleaction()); menucheckbox.bindchecked( wdcontext.nodeuistate().getnodeinfo().getattribute( IPrivatePopupMenuView.IUIStateElement.IS_MENU_ITEM_SELECTED)); popupmenu.additem(menucheckbox);... else if (wdcontext.currentuistateelement().getdoswaptrays()) Related Content Ready-to-use popup menu sample application: 41TutWD_PopupMenus.zip. This Readme document (PDF 49 KB) describes how to import the sample application into your NetWeaver Developer Studio. Web Dynpro UI Element Reference: MenuBar and PopupMenu How to use Popup Menus in Web Dynpro Applications 13