uPortal 2.4.1
API Documentation

org.jasig.portal.channels
Class CInlineFrame

java.lang.Object
  extended byorg.jasig.portal.channels.BaseMultithreadedChannel
      extended byorg.jasig.portal.channels.CInlineFrame
All Implemented Interfaces:
IMultithreadedCacheable, IMultithreadedChannel

public class CInlineFrame
extends BaseMultithreadedChannel
implements IMultithreadedCacheable

This channel renders content identified by a URL within an inline browser frame. For Browsers without support for IFRAMEs, the channel just presents a link to open the URL in a separate window. See http://www.htmlhelp.com/reference/html40/special/iframe.html for more information on inline frames.

Version:
$Revision: 1.33.2.1 $
Author:
Susan Bramhall

Constructor Summary
CInlineFrame()
           
 
Method Summary
 ChannelCacheKey generateKey(java.lang.String uid)
          Requests the channel to generate a key uniqly describing it's current state, and a description of key usage.
 boolean isCacheValid(java.lang.Object validity, java.lang.String uid)
          Requests the channel to verify validity of the retreived cache based on the validator object.
 void renderXML(org.xml.sax.ContentHandler out, java.lang.String uid)
          Build an XML document and transform for display using org.jasig.portal.util.XSLT Creates IFrame or link depending on browser capability.
 
Methods inherited from class org.jasig.portal.channels.BaseMultithreadedChannel
getRuntimeProperties, receiveEvent, setRuntimeData, setStaticData
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CInlineFrame

public CInlineFrame()
Method Detail

renderXML

public void renderXML(org.xml.sax.ContentHandler out,
                      java.lang.String uid)
               throws PortalException
Build an XML document and transform for display using org.jasig.portal.util.XSLT Creates IFrame or link depending on browser capability. The XML will look something like this:

Specified by:
renderXML in interface IMultithreadedChannel
Overrides:
renderXML in class BaseMultithreadedChannel
Parameters:
out - the content handler to which the channel sends SAX events
uid - a unique ID used to identify the state of the channel
Throws:
PortalException

generateKey

public ChannelCacheKey generateKey(java.lang.String uid)
Description copied from interface: IMultithreadedCacheable
Requests the channel to generate a key uniqly describing it's current state, and a description of key usage.

Specified by:
generateKey in interface IMultithreadedCacheable

isCacheValid

public boolean isCacheValid(java.lang.Object validity,
                            java.lang.String uid)
Description copied from interface: IMultithreadedCacheable
Requests the channel to verify validity of the retreived cache based on the validator object.

Specified by:
isCacheValid in interface IMultithreadedCacheable

uPortal 2.4.1
API Documentation