com.plumtree.portalpages.common.mediator
Class CListURLMediator

java.lang.Object
  com.plumtree.portalpages.common.mediator.CListURLMediator

All Implemented Interfaces:

ICPListIterator

public class CListURLMediator
extends java.lang.Object
implements ICPListIterator

This class uses delegation to pass on link generation requests to the appropriate link mediator. If in 508 or low bandwidth access style, the class delegates to CListURLFullMediator. If not, it delegates to CListURLTemplateLinkMediator. This class is not a real CListURLMediator in itself. It dynamically decides which CListURLMediator to delegate to given the Display Option from the HTML source. From a practical point of view, use the Model methods to get an ICPListEntryIterator appropriate for the navigation you're constructing, and then use a mediator to quickly form HTMLAnchors for those links.

Author:

DavidP

Constructor Summary

CListURLMediator(AActivitySpace aspace, ICPListEntryIterator list)
Constructor for CompoundListASURLMediator.

Method Summary

java.lang.Object	GetEntry() Get the current entry in the list.
java.lang.Object	GetEntryAtIndex(int nIndex) Get the entry at a specific index
ICPListEntryIterator	GetList() Get an iterator, the index is set to before the first element, call Next() to advance to first entry.
boolean	Next() Advances the iterator to next element.
void	SetLabelMaxLength(int nMax) Set the truncation width for all subsequent entries, can be altered between entries during an iteration
void	SetShowImages(boolean bShow) Set to display images for subsequent entries in the list, can be altered between entries during an iteration

Methods inherited from class java.lang.Object

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

Constructor Detail

CListURLMediator

public CListURLMediator(AActivitySpace aspace,
                        ICPListEntryIterator list)

Constructor for CompoundListASURLMediator. Get the iterator interface for the list

Parameters:

aspace - Activity space the links will be generated for

list - List of "link entries" used to create anchors

Method Detail

GetEntry

public java.lang.Object GetEntry()

Description copied from interface: ICPListIterator

Get the current entry in the list. Doesn't advance the iterator

Specified by:

GetEntry in interface ICPListIterator

Returns:

Current entry

See Also:

ICPListIterator.GetEntry()

GetEntryAtIndex

public java.lang.Object GetEntryAtIndex(int nIndex)

Description copied from interface: ICPListIterator

Get the entry at a specific index

Specified by:

GetEntryAtIndex in interface ICPListIterator

Parameters:

nIndex - Index of the entry

Returns:

Entry at specified index

See Also:

ICPListIterator.GetEntryAtIndex(int)

GetList

public ICPListEntryIterator GetList()

Description copied from interface: ICPListIterator

Get an iterator, the index is set to before the first element, call Next() to advance to first entry.

Specified by:

GetList in interface ICPListIterator

Returns:

Iterator for current list

See Also:

ICPListIterator.GetList()

Next

public boolean Next()

Description copied from interface: ICPListIterator

Advances the iterator to next element.

Specified by:

Next in interface ICPListIterator

Returns:

false if no more elements exist, true otherwise

See Also:

ICPListIterator.Next()

SetLabelMaxLength

public void SetLabelMaxLength(int nMax)

Description copied from interface: ICPListIterator

Set the truncation width for all subsequent entries, can be altered between entries during an iteration

Specified by:

SetLabelMaxLength in interface ICPListIterator

Parameters:

nMax - Character position to truncate at

SetShowImages

public void SetShowImages(boolean bShow)

Description copied from interface: ICPListIterator

Set to display images for subsequent entries in the list, can be altered between entries during an iteration

Specified by:

SetShowImages in interface ICPListIterator

Parameters:

bShow - true to show images (default), false to no show images in entries

See Also:

ICPListIterator.SetShowImages(boolean)