Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.jasig.portal.channels
Class CInlineFrame

    java.lang.Object
      org.jasig.portal.channels.BaseMultithreadedChannel
          org.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.39.2.1 $
Author:
  Susan Bramhall

Nested Class Summary

Nested classes/interfaces inherited from class org.jasig.portal.channels.BaseMultithreadedChannel
`BaseMultithreadedChannel.ChannelState`

Field Summary
`private static java.lang.String` | `sslLocation`

Fields inherited from class org.jasig.portal.channels.BaseMultithreadedChannel
`channelStateMap, log`

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.
`private java.lang.String` | `getKey(java.lang.String uid)`
`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
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### sslLocation

    private static final java.lang.String sslLocation

See Also:
  Constant Field Values

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`

### getKey

    private java.lang.String getKey(java.lang.String uid)

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD