Making a new tag and control available

[Former Member]

Scenario

The client wants to maintain uniform look and feel across Enterprise Portal, Corporate website and different in-house web applications. Thereby, the client wants the same set of customized UI controls to be used across all the web applications.

Pre-requisites

JDK

PDK

NetWeaver Developer Studio

Step By Step Procedure

1. Create a class which extends Component Class

This class should define the getter and setter methods for all your tag attributes.

Code Sample:

<p>package com.sdn.controls;import com.sapportals.htmlb.Component;public class SDNButton extends Component { String id; String text; String style; String onClientClick;   public SDNButton(String id){  setId(id); }  public SDNButton(String name, String text){  setId(name);  setText(text); }  public String getText() {  return text; } public void setText(String text) {  this.text = text; } public String getStyle() {  return style; } public void setStyle(String style) {  this.style = style; }  public String getOnClientClick() {  return onClientClick; } public void setOnClientClick(String callJSMethod) {  onClientClick = callJSMethod; }  public String getUI() {  return "SDNButton"; }}</p>

2. Create a tag handler class for the UI element. This class extends TagSupport.

This class helps you to create the tag and make it available for use in HTML or JSPs.

Code Sample:

<p>package com.sdn.controls;import javax.servlet.jsp.*;import javax.servlet.jsp.tagext.*;public class ButtonControlTag extends TagSupport {  private String strText;  private String strStyle;  private String strOnClientClick;    private String id = null;  private String text = null;  private String style = null;  private String onClientClick = null;     private String htmlControlText;        private static final String BUTTON_CSS = "/css/WB2style.css";  private static String webResource = "/irj/portalapps/com.sdn.controls";  private static String imageWebResource = webResource+"/images";    SDNButton sDNButtonObject;  JspWriter out;       // Constructor  public ButtonControlTag(){   SDNButtonObject = new SDNButton("mySDNButton");  }   // Getter and setter Methods  public String getId(){   return id;  }    public void setId(String value){   SDNButtonObject.setId(value);   id = value;  }    public String getText() {   return text;  }    public void setText(String string) {   SDNButtonObject.setText(string);   text = string;  }    public String getStyle() {   return style;  }    public void setStyle(String string) {   SDNButtonObject.setStyle(string);   style = string;  }    public String getOnClientClick() {   return onClientClick;  }  public void setOnClientClick(String string) {   SDNButtonObject.setOnClientClick(string);   onClientClick = string;  }  // Define the tag creation method// Style is an optional attribuate. Default style is white// The mandatory attributes of this tag are: id, text and onClientClick. The values for these attributes are fetched and used // here dynamically     public int doStartTag() throws JspException  {   try{       JspWriter out = pageContext.getOut();       if(SDNButtonObject.getText()!=null)     strText = SDNButtonObject.getText();    if(SDNButtonObject.getStyle()!=null)     strStyle = SDNButtonObject.getStyle();    else     strStyle = "white";    if(SDNButtonObject.getOnClientClick()!=null)     strOnClientClick = SDNButtonObject.getOnClientClick();               if(strStyle!=null && strStyle.equalsIgnoreCase("blue")){        htmlControlText =  "</p>" +
"

" +
"" +
"" +
"" +
"" +
"" +
"" +
"

"+strText+"

" +
"

";
}
else{

htmlControlText = "" +
"

" +
"" +
"" +
"" +
"" +
"" +
"" +
"

"+strText+"

" +
"

";
}

out.write(htmlControlText);

}catch(Exception ex){

ex.printStackTrace();
}

return 1;
}

// Define the doEndTag method
public int doEndTag() throws JspException
{
return super.doEndTag();
}
}

3. Create a service

Code Sample:

  import com.sapportals.portal.prt.service.IServiceContext;

  public class SDNControlService implements ISDNControlService{

  private IServiceContext mm_serviceContext;

  /**

• Generic init method of the service. Will be called by the portal runtime.

• @param serviceContext

  */

  public void init(IServiceContext serviceContext)

  {

    mm_serviceContext = serviceContext;

  }

  /**

• This method is called after all services in the portal runtime

• have already been initialized.

  */

  public void afterInit()

  {

  }

  /**

• configure the service

• @param configuration

• @deprecated

  */

  public void configure(com.sapportals.portal.prt.service.IServiceConfiguration configuration)

  {

  }

  /**

• This method is called by the portal runtime

• when the service is destroyed.

  */

  public void destroy()

  {

  }

  /**

• This method is called by the portal runtime

• when the service is released.

• @deprecated

  */

  public void release()

  {

  }

  /**

• @return the context of the service, which was previously set

• by the portal runtime

  */

  public IServiceContext getContext()

  {

    return mm_serviceContext;

  }

  /**

• This method should return a string that is unique to this service amongst all

• other services deployed in the portal runtime.

• @return a unique key of the service

  */

  public String getKey()

  {

    return KEY;

  }

}