org.apache.jetspeed.portal.portlets
Class IFramePortlet

java.lang.Object
  extended byorg.apache.jetspeed.portal.portlets.AbstractPortlet
      extended byorg.apache.jetspeed.portal.portlets.AbstractInstancePortlet
          extended byorg.apache.jetspeed.portal.portlets.IFramePortlet
All Implemented Interfaces:
Cacheable, Portlet, PortletState, org.apache.turbine.services.cache.Refreshable, java.io.Serializable
Direct Known Subclasses:
BASICAuthIFramePortlet

public class IFramePortlet
extends AbstractInstancePortlet

A Portlet that displays the contents of a source URL in an IFRAME tag. portlets.xreg Usage example:

           
     
local-portlets.xreg Usage example:
           
     

The following parameters are accepted:

Version:
$Id: IFramePortlet.java,v 1.7 2004/02/23 04:03:34 jford Exp $
Author:
Bill Barnhill, Mark Orciuch
See Also:
AbstractPortlet, Serialized Form

Field Summary
 
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
IFramePortlet()
           
 
Method Summary
 java.lang.String getAlign()
          Gets the aling attribute of the IFramePortlet object
 org.apache.ecs.ConcreteElement getContent(org.apache.turbine.util.RunData runData)
          This methods outputs the content of the portlet for a given request.
 java.lang.String getFrameBorder()
          Gets whether to display a border around the IFRAME.
 java.lang.String getFrameName()
          Gets iframe name
 java.lang.String getHeight()
          Gets the height attribute of the IFramePortlet object
 java.lang.String getMarginHeight()
          Gets the marginheight attribute of the IFramePortlet object
 java.lang.String getMarginWidth()
          Gets the marginwidth attribute of the IFramePortlet object
 java.lang.String getNotSupportedMsg()
          Gets the message displayed when IFRAME is not supported This includes when Frames are turned off.
 java.lang.String getRefresh()
          Gets iframe refresh
 java.lang.String getScrolling()
          Gets the scrolling attribute of the IFramePortlet object
 java.lang.String getSource()
          Gets the source attribute of the IFramePortlet object
 java.lang.String getStyle()
          Gets iframe style
 java.lang.String getWidth()
          Gets the width attribute of the IFramePortlet object
 void init()
          Initialize this portlet by setting inst.
 void setAlign(java.lang.String value)
          Sets the marginheight attribute of the IFramePortlet object
 void setFrameBorder(java.lang.String frameBorder)
          Sets the frameBorder attribute of the IFramePortlet object
 void setFrameName(java.lang.String value)
          Sets the name of iframe.
 void setHeight(java.lang.String height)
          Sets the height attribute of the IFramePortlet object
 void setMarginHeight(java.lang.String height)
          Sets the marginheight attribute of the IFramePortlet object
 void setMarginWidth(java.lang.String width)
          Sets the width attribute of the IFramePortlet object
 void setRefresh(java.lang.String value)
          Sets the refresh meta tag
 void setScrolling(java.lang.String scrolling)
          Sets the scrolling attribute of the IFramePortlet object
 void setSource(java.lang.String source)
          Sets the source attribute of the IFramePortlet object
 void setStyle(java.lang.String value)
          Sets the style of iframe.
 void setWidth(java.lang.String width)
          Sets the width attribute of the IFramePortlet object
 
Methods inherited from class org.apache.jetspeed.portal.portlets.AbstractInstancePortlet
getHandle
 
Methods inherited from class org.apache.jetspeed.portal.portlets.AbstractPortlet
allowClose, allowCustomize, allowInfo, allowMaximize, allowMinimize, allowPrintFriendly, allowView, clearContent, getAllowEdit, getAllowMaximize, getAllowView, getAttribute, getContent, getContent, getCreationTime, getDescription, getDescription, getExpirationMillis, getExpire, getHandle, getID, getImage, getImage, getInstance, getName, getPortletConfig, getTitle, getTitle, isCacheable, isClosed, isMinimized, isShowTitleBar, providesCustomization, refresh, setAttribute, setCacheable, setCachedObject, setClosed, setContent, setContent, setContent, setCreationTime, setDescription, setExpirationMillis, setHandle, setID, setImage, setMinimized, setName, setPortletConfig, setTitle, setTitle, supportsType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IFramePortlet

public IFramePortlet()
Method Detail

setSource

public void setSource(java.lang.String source)
Sets the source attribute of the IFramePortlet object

Parameters:
source - The new source value
Since:

setScrolling

public void setScrolling(java.lang.String scrolling)
Sets the scrolling attribute of the IFramePortlet object

Parameters:
scrolling - The new scrolling value
Since:

setWidth

public void setWidth(java.lang.String width)
Sets the width attribute of the IFramePortlet object

Parameters:
width - The new width value
Since:

setHeight

public void setHeight(java.lang.String height)
Sets the height attribute of the IFramePortlet object

Parameters:
height - The new height value
Since:

setFrameBorder

public void setFrameBorder(java.lang.String frameBorder)
Sets the frameBorder attribute of the IFramePortlet object

Parameters:
frameBorder - The new frameBorder value
Since:

setMarginWidth

public void setMarginWidth(java.lang.String width)
Sets the width attribute of the IFramePortlet object

Parameters:
width - The new width value

setMarginHeight

public void setMarginHeight(java.lang.String height)
Sets the marginheight attribute of the IFramePortlet object

Parameters:
height - The new height value

setAlign

public void setAlign(java.lang.String value)
Sets the marginheight attribute of the IFramePortlet object


setRefresh

public void setRefresh(java.lang.String value)
Sets the refresh meta tag

Parameters:
value - in seconds

setStyle

public void setStyle(java.lang.String value)
Sets the style of iframe. Some useful style effects:

Parameters:
value -

setFrameName

public void setFrameName(java.lang.String value)
Sets the name of iframe. This is useful when referencing the iframe as a target from another link.

Parameters:
value -

getContent

public org.apache.ecs.ConcreteElement getContent(org.apache.turbine.util.RunData runData)
This methods outputs the content of the portlet for a given request.

Specified by:
getContent in interface Portlet
Overrides:
getContent in class AbstractPortlet
Parameters:
runData - the RunData object for the request
Returns:
the content to be displayed to the user-agent

getSource

public java.lang.String getSource()
Gets the source attribute of the IFramePortlet object

Returns:
The source value

getScrolling

public java.lang.String getScrolling()
Gets the scrolling attribute of the IFramePortlet object

Returns:
The scrolling value

getWidth

public java.lang.String getWidth()
Gets the width attribute of the IFramePortlet object

Returns:
The width value

getHeight

public java.lang.String getHeight()
Gets the height attribute of the IFramePortlet object

Returns:
The height value

getFrameBorder

public java.lang.String getFrameBorder()
Gets whether to display a border around the IFRAME. "1" == yes.

Returns:
The frameBorder value

getNotSupportedMsg

public java.lang.String getNotSupportedMsg()
Gets the message displayed when IFRAME is not supported This includes when Frames are turned off.

Returns:
The notSupportedMsg value

getAlign

public java.lang.String getAlign()
Gets the aling attribute of the IFramePortlet object

Returns:
The marginheight value

getStyle

public java.lang.String getStyle()
Gets iframe style

Returns:
The style value

getFrameName

public java.lang.String getFrameName()
Gets iframe name

Returns:
The name value

getRefresh

public java.lang.String getRefresh()
Gets iframe refresh

Returns:
The refresh value

getMarginHeight

public java.lang.String getMarginHeight()
Gets the marginheight attribute of the IFramePortlet object

Returns:
The marginheight value

getMarginWidth

public java.lang.String getMarginWidth()
Gets the marginwidth attribute of the IFramePortlet object

Returns:
The marginwidth value

init

public void init()
          throws PortletException
Initialize this portlet by setting inst. vars from InitParamaters.

Specified by:
init in interface Portlet
Overrides:
init in class AbstractPortlet
Throws:
PortletException - Initialization failed


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