Custom WebtopBrowserTree Control

udeleng

I'm trying to customize the WebtopBrowserTree control so that perhaps I may be able to expand the Cabinets node on login. I've created the control and tag classes, but it control doesn't seem to use my custom WebtopBrowserTree control class, although it does use the custom Tag class. Maybe someone here can see something I missed.

Here is what I've done:

Note: both control and tag classes are in the same package.

Control Class:

package com.xyz.web.form.control;

public class WebTopBrowserTree extends com.documentum.webtop.control.WebTopBrowserTree {

     public WebTopBrowserTree() {
        System.out.println("WebTopBrowserTree constructor");
     }

     @Override
     public void onInit(ArgumentList args) {

          System.out.println("WebTopBrowserTree.onInit");

          super.onInit(args);

     }

}

Tag Class:

public class WebTopBrowserTreeTag extends com.documentum.webtop.control.WebTopBrowserTreeTag {

    @Override
    public Control getControl() {
        Control control = super.getControl();
        System.out.println("WebTopBrowserTreeTag.getControl() - " + control.getClass());
        return control;
    }
   
    @Override
    protected Class getControlClass() {
        return com.xyz.web.form.control.WebTopBrowserTree.class;
    }
   
}

TLD:

<tag>
      <name>browsertree</name>
      <tagclass>com.xyz.web.form.control.WebTopBrowserTreeTag</tagclass>

     ...

</tag>

JSP:

<%@ taglib uri="/WEB-INF/tlds/agnform_1_0.tld" prefix="agn" %>

...

<agn:browsertree name='<%=BrowserTree.TREE_CONTROL%>' ... />

Here is the OUTPUT I get:

WebTopBrowserTreeTag.getControl() - class com.documentum.webtop.control.WebTopBrowserTree
WebTopBrowserTreeTag.getControl() - class com.documentum.webtop.control.WebTopBrowserTree
WebTopBrowserTreeTag.getControl() - class com.documentum.webtop.control.WebTopBrowserTree
WebTopBrowserTreeTag.getControl() - class com.documentum.webtop.control.WebTopBrowserTree
WebTopBrowserTreeTag.getControl() - class com.documentum.webtop.control.WebTopBrowserTree
WebTopBrowserTreeTag.getControl() - class com.documentum.webtop.control.WebTopBrowserTree

BartThierens

I've done this customization before and I always use the following approach.

The BrowserTree component:

public class BrowserTree extends com.documentum.webtop.webcomponent.browsertree.BrowserTree 
{

     private static final long serialVersionUID = 7184723267628919658L;

     
     /**
      * Default constructor
      */
     public BrowserTree() 
     {
          super();
     }
     
     
     /**
      * Overridden <code>onInit</code> to forcefully create a {@link WebTopBrowserTree}.
      * 
      * @param args     argument list
      */
     @SuppressWarnings("unused")
     @Override
     public void onInit(ArgumentList args)
     {
          //force creation of custom control in component
          WebTopBrowserTree tree = (WebTopBrowserTree) getControl(
                    TREE_CONTROL, WebTopBrowserTree.class);
          
          super.onInit(args);
     }
}

The WebTopBrowserTree control:

public class WebTopBrowserTree extends com.documentum.webtop.control.WebTopBrowserTree 
{

     private static final long serialVersionUID = 7184723267628919658L;
     
     /**
      * Overridden <code>onInit</code> method to call <code>removeAddRepositoryLink()</code>
      * 
      * @param args     argument list
      */
     @Override 
     public void onInit(ArgumentList args)
     {
          super.onInit(args);
          
          // do your custom stuff like removing nodes, etc.
     }
}

The Tag-class:

public class WebTopBrowserTreeTag extends com.documentum.webtop.control.WebTopBrowserTreeTag 
{

     private static final long serialVersionUID = -2709576601045142035L;
     
     
     /**
      * Overridden <code>getControlClass</code> method that returns the custom
      * {@link WebTopBrowserTree} as control class.
      */
     @SuppressWarnings("unchecked")
     @Override
     protected Class getControlClass() 
     {
          return com.mycompany.WebTopBrowserTree.class;
     }

}

Then you need to create a custom tld for your control.

Just open the default tld and search for the browsertree-part.

Copy that part into a new tld and change the tagclass:

<taglib>
   
   <tlibversion>1.0</tlibversion>
   <jspversion>1.1</jspversion>
   <shortname>mycompany</shortname>
   
   <tag>
      <name>browsertree</name>
      <tagclass>be.vdab.ep.wdk.browsertree.WebTopBrowserTreeTag</tagclass>
      <bodycontent>jsp</bodycontent>
     ...
     </tag>
</taglib>

And then for the last step, extend browsertree.jsp and add your custom tld:
<%@ taglib uri="/WEB-INF/tlds/mycompany.tld" prefix="mycompany" %>

Also replace the documentum BrowserTree import with your own

<%@ page import="com.documentum.web.form.Form,
                 com.documentum.web.common.ClientInfo,
                 com.documentum.web.common.ClientInfoService,
                 com.mycompany.BrowserTree" %>

Then search for the part in the jsp the control is added, and replace dmf with your tag:

 <mycompany:browsertree name='<%=BrowserTree.TREE_CONTROL%>' onclick='onclickTree'
   normalclass='browserTreeNormal' selectedclass='browserTreeSelected'
    ondrop='onDrop' dragenabled='true' showroot='false'/>

I suggest also giving the BrowserTree the same name so you don't have to replace BrowserTree with CustomBrowserTree in your jsp every time it is used.

So basicly, what you did is correct, but I would suggest forcefully creating the Control in your custom BrowserTree component