org.jasig.portal.channels
Class CImage

java.lang.Object
  org.jasig.portal.channels.BaseChannel
      org.jasig.portal.channels.CImage

All Implemented Interfaces:

ICacheable, IChannel

Deprecated. All IChannel implementations should be migrated to portlets

@Deprecated
public class CImage
extends BaseChannel
implements ICacheable, IChannel

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
alt-text	Text to include as the 'alt' attribute of the img tag	Almost live shot of Hamilton library front enterance	no, but highly recommended in support of non-visual browsers

Version:

$Revision: 19776 $

Author:

Ken Weiner, kweiner@unicon.net

Field Summary

static String

ALT_TEXT_CHANNEL_PARAM_NAME Deprecated.

Fields inherited from class org.jasig.portal.channels.BaseChannel

log, runtimeData, staticData

Fields inherited from interface org.jasig.portal.ICacheable

CHANNEL_CACHE_KEY_INSTANCE_SCOPE, CHANNEL_CACHE_KEY_SCOPE_PARAM_NAME, CHANNEL_CACHE_KEY_SYSTEM_SCOPE

Constructor Summary

CImage()
Deprecated.

Method Summary

ChannelCacheKey	generateKey() Deprecated. Requests the channel to generate a key uniquely describing its current state, and a description of key usage.
boolean	isCacheValid(Object validity) Deprecated. Requests the channel to verify validity of the retrieved cache based on the validator object.
void	renderXML(ContentHandler out) Deprecated. Output channel content to the portal

Methods inherited from class org.jasig.portal.channels.BaseChannel

getRuntimeProperties, receiveEvent, setRuntimeData, setStaticData, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jasig.portal.IChannel

getRuntimeProperties, receiveEvent, setRuntimeData, setStaticData

Field Detail

ALT_TEXT_CHANNEL_PARAM_NAME

public static final String ALT_TEXT_CHANNEL_PARAM_NAME

Deprecated.

See Also:

Constant Field Values

Constructor Detail

CImage

public CImage()

Deprecated.

Method Detail

renderXML

public void renderXML(ContentHandler out)
               throws PortalException

Deprecated.

Output channel content to the portal

Specified by:

renderXML in interface IChannel

Overrides:

renderXML in class BaseChannel

Parameters:

out - a sax content handler

Throws:

PortalException

generateKey

public ChannelCacheKey generateKey()

Deprecated.

Description copied from interface: ICacheable

Requests the channel to generate a key uniquely describing its current state, and a description of key usage.

Specified by:

generateKey in interface ICacheable

isCacheValid

public boolean isCacheValid(Object validity)

Deprecated.

Description copied from interface: ICacheable

Requests the channel to verify validity of the retrieved cache based on the validator object.

Specified by:

isCacheValid in interface ICacheable