org.apache.jetspeed.portal.controls
Class TitleControl

java.lang.Object
  extended byorg.apache.jetspeed.portal.portlets.AbstractPortlet
      extended byorg.apache.jetspeed.portal.controls.AbstractPortletControl
          extended byorg.apache.jetspeed.portal.controls.TitleControl
All Implemented Interfaces:
Cacheable, Portlet, PortletControl, PortletSet, PortletState, org.apache.turbine.services.cache.Refreshable, java.io.Serializable

public class TitleControl
extends AbstractPortletControl

This control renders the title of a portlet for MimeTyps WML and HTML. For WML only the title (represented as a link) is returned. In case that the device requests html the title will be rendered within a titlebar (with buttons for editing or maximizing the portlet).

Version:
$Id: TitleControl.java,v 1.14 2004/02/23 03:25:35 jford Exp $
Author:
Sascha Alda, Stephan Hesmer, Santiago Gala
See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class org.apache.jetspeed.portal.PortletSet
PortletSet.Constraints
 
Field Summary
 
Fields inherited from class org.apache.jetspeed.portal.controls.AbstractPortletControl
BACKGROUND_COLOR, COLOR, TITLE_COLOR, WIDTH
 
Fields inherited from class org.apache.jetspeed.portal.portlets.AbstractPortlet
content
 
Fields inherited from interface org.apache.jetspeed.portal.Portlet
PORTLET_MAXIMIZED, PORTLET_MINIMIZED, PORTLET_NORMAL
 
Constructor Summary
TitleControl()
           
 
Method Summary
 org.apache.ecs.ConcreteElement getContent(org.apache.turbine.util.RunData rundata)
          Method checks, which MimeType is requested.
 org.apache.ecs.ConcreteElement getHTMLContent(org.apache.turbine.util.RunData rundata)
          Method returns content for html, in case that the requested MimeTyp is html.
 java.lang.String getTitle()
          Method returns the title of the portlet, which is placed within this control.
 org.apache.ecs.ConcreteElement getWMLContent(org.apache.turbine.util.RunData rundata)
          Method returns content for WML, in case that the requested MimeTyp is WML.
 boolean supportsType(MimeType mimeType)
          Method checks whether the requested MimeTyp is supported by this control.
 
Methods inherited from class org.apache.jetspeed.portal.controls.AbstractPortletControl
addPortlet, addPortlet, addPortlet, addPortlet, allowClose, allowCustomize, allowInfo, allowMaximize, allowMinimize, allowPrintFriendly, getBackgroundColor, getColor, getConfig, getController, getDescription, getID, getName, getPortlet, getPortletAt, getPortletByID, getPortletByName, getPortletConfig, getPortlets, getTitleColor, getWidth, init, init, isClosed, isMinimized, setBackgroundColor, setClosed, setColor, setConfig, setController, setDescription, setID, setMinimized, setName, setPortlet, setPortletConfig, setTitle, setTitleColor, setWidth, setWidth, size, toArray
 
Methods inherited from class org.apache.jetspeed.portal.portlets.AbstractPortlet
allowView, clearContent, getAllowEdit, getAllowMaximize, getAllowView, getAttribute, getContent, getContent, getCreationTime, getDescription, getExpirationMillis, getExpire, getHandle, getHandle, getImage, getImage, getInstance, getTitle, isCacheable, isShowTitleBar, providesCustomization, refresh, setAttribute, setCacheable, setCachedObject, setContent, setContent, setContent, setCreationTime, setExpirationMillis, setHandle, setImage, setTitle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.jetspeed.portal.Portlet
getAllowEdit, getAllowMaximize, getAllowView, getAttribute, getCreationTime, getDescription, getImage, getInstance, getTitle, isShowTitleBar, providesCustomization, setAttribute, setCreationTime, setImage, setTitle
 

Constructor Detail

TitleControl

public TitleControl()
Method Detail

getContent

public org.apache.ecs.ConcreteElement getContent(org.apache.turbine.util.RunData rundata)
Method checks, which MimeType is requested. According to this MimeTyp, the appropriate method is invoked (getWMLContent() or getHTMLContent() ).

Specified by:
getContent in interface Portlet
Overrides:
getContent in class AbstractPortletControl
Parameters:
rundata - RunData object from Turbine.
Returns:
ConcreteElement object, including the complete ECS code for rendering the page.

getHTMLContent

public org.apache.ecs.ConcreteElement getHTMLContent(org.apache.turbine.util.RunData rundata)
Method returns content for html, in case that the requested MimeTyp is html.

Parameters:
rundata - RunData object from Turbine.
Returns:
ConcreteElement object, including the complete ECS code for rendering the html page.

getWMLContent

public org.apache.ecs.ConcreteElement getWMLContent(org.apache.turbine.util.RunData rundata)
Method returns content for WML, in case that the requested MimeTyp is WML.

Parameters:
rundata - RunData object from Turbine.
Returns:
ConcreteElement object, including the complete ECS code for rendering the html page.

getTitle

public java.lang.String getTitle()
Method returns the title of the portlet, which is placed within this control.

Specified by:
getTitle in interface Portlet
Overrides:
getTitle in class AbstractPortletControl
Returns:
String object, representing the portlet's title.

supportsType

public boolean supportsType(MimeType mimeType)
Method checks whether the requested MimeTyp is supported by this control. Moreover, it checks, if the included portlet fits the given MimeTyp as well. Thus, the method returns true, iff both the control and the portlet(set) support the requested MimeType. Otherwise false is returned.

Specified by:
supportsType in interface Portlet
Overrides:
supportsType in class AbstractPortletControl
Parameters:
mimeType - MimeType object describing the requested MimeTyp.
Returns:
Boolean true if MimeTyp is supported, false if not.
See Also:
Portlet.supportsType(org.apache.jetspeed.util.MimeType)


Copyright © 2000-2005 Apache Software Foundation. All Rights Reserved.