|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.channels.BaseMultithreadedChannel
org.jasig.portal.channels.CImage
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 |
Constructor Summary | |
CImage()
|
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)
Output channel content to the portal |
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 |
public CImage()
Method Detail |
public void renderXML(org.xml.sax.ContentHandler out, java.lang.String uid) throws PortalException
renderXML
in interface IMultithreadedChannel
renderXML
in class BaseMultithreadedChannel
out
- a sax content handleruid
- a unique ID used to identify the state of the channel
PortalException
public ChannelCacheKey generateKey(java.lang.String uid)
IMultithreadedCacheable
generateKey
in interface IMultithreadedCacheable
public boolean isCacheValid(java.lang.Object validity, java.lang.String uid)
IMultithreadedCacheable
isCacheValid
in interface IMultithreadedCacheable
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |