com.arsdigita.portalserver
Class PortalTab

java.lang.Object
  extended bycom.arsdigita.domain.DomainObject
      extended bycom.arsdigita.domain.ObservableDomainObject
          extended bycom.arsdigita.kernel.ACSObject
              extended bycom.arsdigita.kernel.Resource
                  extended bycom.arsdigita.portal.Portal
                      extended bycom.arsdigita.portalserver.PortalTab
Direct Known Subclasses:
SubPortalTab

public class PortalTab
extends com.arsdigita.portal.Portal

A PortalTab is a tool organizing content in a Portal. A PortalTab includes logic for sorting and displaying portlets in a specific layout manner.

Author:
Jim Parsons

Field Summary
static String BASE_DATA_OBJECT_TYPE
          The type of the DataObject that stands behind this DomainObject.
 
Fields inherited from class com.arsdigita.portal.Portal
versionId
 
Fields inherited from class com.arsdigita.kernel.Resource
CHILD_RESOURCE, DESCRIPTION, PARENT_RESOURCE, RESOURCE_TYPE, TIMESTAMP, TITLE
 
Fields inherited from class com.arsdigita.kernel.ACSObject
CONTAINER, DEFAULT_DOMAIN_CLASS, DISPLAY_NAME, ID, OBJECT_TYPE
 
Constructor Summary
PortalTab(com.arsdigita.persistence.DataObject dataObject)
           
 
Method Summary
 void afterSave()
           
protected  void beforeSave()
           
static PortalTab createTab(String title)
           
static PortalTab createTab(String title, com.arsdigita.kernel.Resource parent)
           
static boolean doesTabExist(BigDecimal bd)
           
protected  String getBaseDataObjectType()
           
 String getLayout()
           
 PortalSite getPortalSite()
           
 int getSortKey()
          Get the sort key of this PortalTab.
static PortalTabCollection getTabsForPortalSite(PortalSite p)
           
 String getTitle()
          Get the title of this PortalTab.
static PortalTabCollection retrieveAllTabs()
          This is an unusual method that retrieves ALL Portal Tabs...
static PortalTab retrieveTab(BigDecimal prtlTabID)
          Retrieve an existing PortalTab based on a PortalTab ID.
static PortalTab retrieveTab(com.arsdigita.persistence.DataObject dataObject)
          Retrieve an existing PortalTab based on a portal_tab data object.
static PortalTab retrieveTab(com.arsdigita.persistence.OID oid)
          Retrieve an existing PortalTab based on an OID.
 void setLayout(String layout)
           
 void setPortalSite(PortalSite psite)
           
 void setSortKey(int sortKey)
           
 void setTitle(String title)
          Set the title of this PortalTab.
 
Methods inherited from class com.arsdigita.portal.Portal
addPortlet, clearPortlets, create, create, createTemplate, getPortlets, getPortletsForCell, isTemplate, movePortletToHead, movePortletToTail, retrieve, retrieve, retrieve, retrieveAll, setTemplate, swapPortletWithNext, swapPortletWithPrevious
 
Methods inherited from class com.arsdigita.kernel.Resource
createResource, createResource, getChildResources, getContainer, getContainingResource, getDescription, getDisplayName, getParentResource, getResourceType, getTimestamp, isContainerModified, retrieveAllResources, retrieveResource, retrieveResource, retrieveResource, setDescription, setParentResource, setResourceType
 
Methods inherited from class com.arsdigita.kernel.ACSObject
assertPrivilege, checkPrivilege, doCreateCheck, doWriteCheck, getDefaultDomainClass, getID, getSpecificObjectType, getSpecificOID, gimmeContainer, initialize, setID, setID
 
Methods inherited from class com.arsdigita.domain.ObservableDomainObject
addObserver, getObservers
 
Methods inherited from class com.arsdigita.domain.DomainObject
add, add, addToAssociation, afterDelete, beforeDelete, clear, delete, disconnect, equals, get, getObjectType, getOID, getSession, hashCode, isDeleted, isDisconnected, isModified, isNew, isPropertyModified, isValid, remove, remove, remove, removeFromAssociation, save, set, setAssociation, setAssociation, specializeDataObject, specializeDataObject, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

BASE_DATA_OBJECT_TYPE

public static final String BASE_DATA_OBJECT_TYPE
The type of the DataObject that stands behind this DomainObject.

See Also:
Constant Field Values
Constructor Detail

PortalTab

public PortalTab(com.arsdigita.persistence.DataObject dataObject)
Method Detail

getBaseDataObjectType

protected String getBaseDataObjectType()

createTab

public static PortalTab createTab(String title,
                                  com.arsdigita.kernel.Resource parent)

createTab

public static PortalTab createTab(String title)

retrieveTab

public static PortalTab retrieveTab(BigDecimal prtlTabID)
Retrieve an existing PortalTab based on a PortalTab ID.

Returns:
an existing PortalTab. Note that the return value may be null if no PortalTab of this ID exists.

retrieveTab

public static PortalTab retrieveTab(com.arsdigita.persistence.DataObject dataObject)
Retrieve an existing PortalTab based on a portal_tab data object.

Parameters:
dataObject - the data object of the PortalTab to retrieve.
Returns:
an existing PortalTab. Note that the return value may be null if no PortalTab data object for this ID exists.

retrieveTab

public static PortalTab retrieveTab(com.arsdigita.persistence.OID oid)
Retrieve an existing PortalTab based on an OID.

Parameters:
oid - the OID of the PortalTab to retrieve.

doesTabExist

public static boolean doesTabExist(BigDecimal bd)

retrieveAllTabs

public static PortalTabCollection retrieveAllTabs()
This is an unusual method that retrieves ALL Portal Tabs...


getTabsForPortalSite

public static PortalTabCollection getTabsForPortalSite(PortalSite p)

getTitle

public String getTitle()
Get the title of this PortalTab.

Returns:
this tab's title.

setTitle

public void setTitle(String title)
Set the title of this PortalTab.

Parameters:
title - the new title.

setPortalSite

public void setPortalSite(PortalSite psite)

getPortalSite

public PortalSite getPortalSite()

getSortKey

public int getSortKey()
Get the sort key of this PortalTab. The sort key is used to order a set of tabs in a particular Portal Site.

Returns:
the portal sort key.

setSortKey

public void setSortKey(int sortKey)

getLayout

public String getLayout()

setLayout

public void setLayout(String layout)

beforeSave

protected void beforeSave()

afterSave

public void afterSave()


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