com.arsdigita.portalserver.ui.admin
Class PortalTreeModelBuilder

java.lang.Object
  extended bycom.arsdigita.util.LockableImpl
      extended bycom.arsdigita.portalserver.ui.admin.PortalTreeModelBuilder
All Implemented Interfaces:
com.arsdigita.util.Lockable, com.arsdigita.bebop.tree.TreeModelBuilder

public class PortalTreeModelBuilder
extends com.arsdigita.util.LockableImpl
implements com.arsdigita.bebop.tree.TreeModelBuilder

TreeModelBuilder for Portal Site hierarchies. This Class will work in two different modes by setting the internal boolean class var. This can be done during construction or via a setter method. A true value filters PortalSites to include only those that are online. This mode is helpful for typical user UI. If the value is set to false, then all Portal Sites, including those that are archived and in Draft status, are included in the tree model. This mode is useful for admin UI.


Nested Class Summary
static class PortalTreeModelBuilder.DefaultRenderer
           
 
Field Summary
 
Fields inherited from interface com.arsdigita.bebop.tree.TreeModelBuilder
versionId
 
Constructor Summary
PortalTreeModelBuilder()
          Construct a new PortalTreeModelBuilder whose root is the toplevel portal.
PortalTreeModelBuilder(BigDecimal rootprtlId)
          Construct a new PortalTreeModelBuilder whose root is the portal with the specified ID.
PortalTreeModelBuilder(BigDecimal rootprtlId, boolean filterPSites)
           
PortalTreeModelBuilder(boolean filterPSites)
           
 
Method Summary
 boolean getFilterPSites()
          Get the filter mode value for this ModelBuilder.
 BigDecimal getRootID()
          Get the ID of the portal at which the tree built by this ModelBuilder will be rooted.
 com.arsdigita.bebop.tree.TreeModel makeModel(com.arsdigita.bebop.Tree t, com.arsdigita.bebop.PageState s)
           
 void setFilterPSites(boolean filterPSites)
          Set the filter mode value for this ModelBuilder.
 
Methods inherited from class com.arsdigita.util.LockableImpl
isLocked, lock
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.arsdigita.util.Lockable
isLocked, lock
 

Constructor Detail

PortalTreeModelBuilder

public PortalTreeModelBuilder()

Construct a new PortalTreeModelBuilder whose root is the toplevel portal.


PortalTreeModelBuilder

public PortalTreeModelBuilder(boolean filterPSites)

PortalTreeModelBuilder

public PortalTreeModelBuilder(BigDecimal rootprtlId)

Construct a new PortalTreeModelBuilder whose root is the portal with the specified ID.


PortalTreeModelBuilder

public PortalTreeModelBuilder(BigDecimal rootprtlId,
                              boolean filterPSites)
Method Detail

getRootID

public BigDecimal getRootID()

Get the ID of the portal at which the tree built by this ModelBuilder will be rooted.


getFilterPSites

public boolean getFilterPSites()

Get the filter mode value for this ModelBuilder.


setFilterPSites

public void setFilterPSites(boolean filterPSites)

Set the filter mode value for this ModelBuilder. Setting this value to false results in the TreeModel including ALL PortalSites in the system: Archived and Draft versions as well as online Portal Sites. A true value for this parameter filters PortalSite collections to include only online Portal Sites.


makeModel

public com.arsdigita.bebop.tree.TreeModel makeModel(com.arsdigita.bebop.Tree t,
                                                    com.arsdigita.bebop.PageState s)
Specified by:
makeModel in interface com.arsdigita.bebop.tree.TreeModelBuilder


Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 20 2004:2344 UTC