Creating a Development Component

Transcription

1 Applies To: SAP WAS 6.40 SP9, NWDS Summary This blog attempts to develop a reusable utility component which can be used in WebDynpro development using NWDS and there by reducing the development time. In doing so, the steps for a creating a Development Component (DC) using NetWeaver Developer Studio (NWDS) and using an already existing DC in a new DC project, are illustrated. By: Renjith John Andrews Company and Title: Wipro Technologies, Associate Consultant Date: 03 Mar SAP AG 1

2 Creating a Utility DC The component intents to provide a similar functionality to that of the ABAP Function Module REUSE_ALV_GRID_DISPLAY - To this component, when we supply a field catalog, reference to a view & a container name; it will create a table with columns as per the field catalog and attach it to the particular container in the referred view. Let us head into creating the reusable DC. First create a new DC project. I have named it as the tableutility DC. The properties of the DC are as shown below SAP AG 2

3 Then create a new java package in this DC SAP AG 3

4 Create a new Java Class in the package that we created. Add a method createtable in this class, with the code as written below. This method takes in 4 formal parameters 1) A field catalog node containing information on the table columns, 2) The data source name for the table, 3) The view to which the table needs to be attached and 4) also the container name to which the table needs to be attached. In the sample that I have created, it supports 4 types of columns input field, check box, caption and text view. For the field Catalog nodes following attributes are expected to be there: 2005 SAP AG 4

5 COLHDR heading to be given for the column, TYPE type of the column, whether it is input field, check box etc.., VALUE the context element to which the main property of the element is attached. for ex: if it is an input field, the this context element would be bound to the value attribute of the dynamically created column or if it is a check box, it is bound to the checked attribute of the column. TEXT the context element path to which text property of the column will be attached. The code that I have written is self-explanatory (hopefully) public static void createtable(iwdnode nodecatalog,string datasource,iwdview view,string containername){ int no_cols = nodecatalog.size(); IWDTableColumn tc = null; IWDTableCellEditor tce = null; IWDCaption cap = null; IWDNodeElement nodeelement = null; IWDInputField inp = null; IWDCheckBox cbinp = null; IWDCaption capinp = null; IWDTextView tvinp = null; IWDTable tableinp = (IWDTable) view.createelement(iwdtable.class,"table123"); tableinp.binddatasource(datasource); for (int i = 0; i < no_cols; i++) { tc = (IWDTableColumn) view.createelement(iwdtablecolumn.class,"col"+i); nodeelement = nodecatalog.getelementat(i); try{ cap = (IWDCaption)view.createElement(IWDCaption.class,"Capt"+i); cap.settext(nodeelement.getattributeastext("colhdr")); tc.setheader(cap); 2005 SAP AG 5

6 if(nodeelement.getattributeastext("type").equalsignorecase("inputfield")){ inp = (IWDInputField)view.createElement(IWDInputField.class,"IF"+i); inp.bindvalue(nodeelement.getattributeastext("value")); tc.settablecelleditor(inp); }else if (nodeelement.getattributeastext("type").equalsignorecase("checkbox")){ cbinp = (IWDCheckBox)view.createElement(IWDCheckBox.class,"CB12"+i); cbinp.bindchecked(nodeelement.getattributeastext("value")); tc.settablecelleditor(cbinp); }else if (nodeelement.getattributeastext("type").equalsignorecase("caption")){ capinp = (IWDCaption)view.createElement(IWDCaption.class,"CAP12"+i); capinp.bindtext(nodeelement.getattributeastext("value")); tc.settablecelleditor(capinp); }else if (nodeelement.getattributeastext("type").equalsignorecase("textview")){ tvinp = (IWDTextView)view.createElement(IWDTextView.class,"TV12"+i); tvinp.bindtext(nodeelement.getattributeastext("value")); } } } catch(exception ee){ } tableinp.addcolumn(tc); tc.settablecelleditor(tvinp); IWDTransparentContainer trcont = (IWDTransparentContainer)view.getElement(containerName); } trcont.addchild(tableinp); 2005 SAP AG 6

7 Create a public Part in our DC. Only the entities in our DC which are exposed as public parts will be accessible to other DCs. For the sample I create a public part called PP_TableUtility as shown in the next 2 pictures SAP AG 7

8 Now our DC is ready for use SAP AG 8

9 Create a Sample DC which would use the utility DC that we created SAP AG 9

10 Now, for using the utility DC we need declare it as a Used DC inside the DC projects DC Metadata DC Defintion. The following picture shows the addition of the Used DC SAP AG 10

11 After having made the used DC reference, declare our Utility DC com.wipro/tableutilty in the webdynpro references sharing references for our sample DC. For doing this, right click on the project select properties from the context menu and add the entry in the sharing references tab SAP AG 11

12 Create a webdynpro application, component and a view. In the view controller, create 2 nodes with following attributes. One node is for creating the field catalog and the other one is for storing the contents of the table which will be created dynamically. The sample view would contain a table with 6 columns and so the 2 nd node has six attributes for storing the contents for 6 columns. If I wasn t very lazy, I would have made this also dynamic. Add the following lines of code in the wddoinit() method. This creates the field catalog for 6 columns as well as creates 2 lines of data to be shown in the table. IWDNodeElement nodeelement = wdcontext.createfieldcatalogelement(); nodeelement.setattributevalue("colhdr","input Field1"); nodeelement.setattributevalue("value","tbcontents.field1"); nodeelement.setattributevalue("type","inputfield"); wdcontext.nodefieldcatalog().addelement(nodeelement); nodeelement = wdcontext.createfieldcatalogelement(); nodeelement.setattributevalue("colhdr","input Field2"); 2005 SAP AG 12

13 nodeelement.setattributevalue("value","tbcontents.field2"); nodeelement.setattributevalue("type","inputfield"); wdcontext.nodefieldcatalog().addelement(nodeelement); nodeelement = wdcontext.createfieldcatalogelement(); nodeelement.setattributevalue("colhdr","input Field3"); nodeelement.setattributevalue("value","tbcontents.field3"); nodeelement.setattributevalue("type","inputfield"); wdcontext.nodefieldcatalog().addelement(nodeelement); nodeelement = wdcontext.createfieldcatalogelement(); nodeelement.setattributevalue("colhdr","check Box"); nodeelement.setattributevalue("value","tbcontents.checkbox"); nodeelement.setattributevalue("type","checkbox"); wdcontext.nodefieldcatalog().addelement(nodeelement); nodeelement = wdcontext.createfieldcatalogelement(); nodeelement.setattributevalue("colhdr","text View"); nodeelement.setattributevalue("value","tbcontents.textview"); nodeelement.setattributevalue("type","textview"); wdcontext.nodefieldcatalog().addelement(nodeelement); nodeelement = wdcontext.createfieldcatalogelement(); nodeelement.setattributevalue("colhdr","caption"); nodeelement.setattributevalue("value","tbcontents.caption"); nodeelement.setattributevalue("type","caption"); wdcontext.nodefieldcatalog().addelement(nodeelement); IWDNodeElement cont = wdcontext.createtbcontentselement(); cont.setattributevalue("field1","col1val"); cont.setattributevalue("field2","col2val"); cont.setattributevalue("field3","col3val"); cont.setattributevalue("caption","caption Data"); 2005 SAP AG 13

14 cont.setattributevalue("textview","this is a long text"); wdcontext.nodetbcontents().addelement(cont); cont = wdcontext.createtbcontentselement(); cont.setattributevalue("field1","col4val"); cont.setattributevalue("field2","col5val"); cont.setattributevalue("field3","col6val"); cont.setattributevalue("checkbox",new Boolean(true)); cont.setattributevalue("caption","caption Data2"); cont.setattributevalue("textview","good one"); wdcontext.nodetbcontents().addelement(cont); Having created the field catalog and the contents, call the method createtable of our utility class in the wddomodifyview method. Pls note the parameters passed : the field catalog node, the Data source path for the table, the view reference and the name of the container to which the table needs to be attached. if(firsttime){ TableUtility.createTable(wdContext.nodeFieldCatalog(),"TBCONTENTS",view,"R ootuielementcontainer"); } Below is the layout diagram of our view in design mode SAP AG 14

15 And last but not least, the view output!!! 2005 SAP AG 15

16 Disclaimer & Liability Notice This document may discuss sample coding, which does not include official interfaces and therefore is not supported. Changes made based on this information are not supported and can be overwritten during an upgrade. SAP will not be held liable for any damages caused by using or misusing of the code and methods suggested here, and anyone using these methods, is doing it under his/her own responsibility. SAP offers no guarantees and assumes no responsibility or liability of any type with respect to the content of the technical article, including any liability resulting from incompatibility between the content of the technical article and the materials and services offered by SAP. You agree that you will not hold SAP responsible or liable with respect to the content of the Technical Article or seek to do so. Author Bio Renjith John Andrews is an Associate Consultant woring with Wipro Technologies, India. Copyright 2005 SAP AG, Inc. All Rights Reserved. SAP, mysap, mysap.com, xapps, xapp, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product, service names, trademarks and registered trademarks mentioned are the trademarks of their respective owners SAP AG 16