org.jasig.portal.channels
Class CImage
java.lang.Object
org.jasig.portal.channels.BaseMultithreadedChannel
org.jasig.portal.channels.CImage
- All Implemented Interfaces:
- IMultithreadedCacheable, IMultithreadedChannel
public class CImage
- extends BaseMultithreadedChannel
- implements IMultithreadedCacheable
A simple channel which renders an image along with an optional
caption and subcaption.
Channel parameters:
Name | Description | Example | Required |
img-uri | The URI of the image to display | http://webcam.its.hawaii.edu/uhmwebcam/image01.jpg | yes |
img-width | The width of the image to display | 320 | no |
img-height | The height of the image to display | 240 | no |
img-border | The border of the image to display | 0 | no |
img-link | A URI to be used as an href for the image | http://www.hawaii.edu/visitor/#webcams | no |
caption | A caption of the image to display | Almost Live Shot of Hamilton Library Front Entrance | no |
subcaption | The subcaption of the image to display | Updated Once per Minute During Daylight Hours | no |
- Version:
- $Revision: 1.23 $
- Author:
- Ken Weiner, kweiner@unicon.net
Field Summary |
private static java.lang.String |
sslLocation
|
Method Summary |
private static boolean |
exists(java.lang.String s)
|
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)
Output channel content to the portal |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
sslLocation
private static final java.lang.String sslLocation
- See Also:
- Constant Field Values
CImage
public CImage()
renderXML
public void renderXML(org.xml.sax.ContentHandler out,
java.lang.String uid)
throws PortalException
- Output channel content to the portal
- Specified by:
renderXML
in interface IMultithreadedChannel
- Overrides:
renderXML
in class BaseMultithreadedChannel
- Parameters:
out
- a sax content handleruid
- a unique ID used to identify the state of the channel
- Throws:
PortalException
exists
private static boolean exists(java.lang.String s)
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)