com.plumtree.portalpages.common.mediator
Class CListURLTemplateLinkMediator

java.lang.Object
  extended by com.plumtree.portalpages.common.mediator.CListURLTemplateMediator
      extended by com.plumtree.portalpages.common.mediator.CListURLTemplateLinkMediator
All Implemented Interfaces:
ICPListIterator

public class CListURLTemplateLinkMediator
extends CListURLTemplateMediator
implements ICPListIterator

This class extends CListURLTemplateMediator generating HTMLAnchors using URL Templates. Clicking on the URL will construct the full URL and redirect to it. The downside with these links is users can't open the link in a new window with "Open in New Window" option since a javascript onclick event is used to trigger the redirect and not the HREF. See javadoc for CListURLTemplateMediator for more information on URL Templates.

Author:
robertz
See Also:
Example use: ICPListIterator mediator = new CListURLTemplateLinkMediator(m_asOwner, cpList1); mediator.SetLabelMaxLength(50); //set the maximum label length to 50 characters while (mediator.Next()) { HTMLAnchor anchor = (HTMLAnchor) mediator.GetEntry(); ... }

Field Summary
 
Fields inherited from class com.plumtree.portalpages.common.mediator.CListURLTemplateMediator
ACTIONIMAGE_SPACE_WIDTH, IMAGE_SPACE_WIDTH, m_strImageAlign, TEMPLATEARR_INDEX_IMGURL, TEMPLATEARR_INDEX_LABEL, TEMPLATEARR_INDEX_URL
 
Constructor Summary
CListURLTemplateLinkMediator(AActivitySpace aspace, ICPListEntryIterator list)
          Constructor for CListURLTemplateLinkMediator.
 
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
 
Methods inherited from class com.plumtree.portalpages.common.mediator.CListURLTemplateMediator
CreateCommPageURLTemplate, CreateDirPageURLTemplate, CreateDocURL, CreateEditorURLTemplate, CreateFullInternalURL, CreateFullURL, CreateGenericURL, CreateMyPageURLTemplate, CreatePrefsURL, CreateSiteMapRootURLTemplate, CreateStringLabel, CreateUserURL, GetEntryOrigLabel, GetImageSource, GetImageString, GetList, GetNonEncodedEntryOrigLabel, IsImageEntry, Next, SetLabelMaxLength, SetListEntryImage, SetShowImages
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.plumtree.portalpages.common.mediator.ICPListIterator
GetList, Next, SetLabelMaxLength, SetShowImages
 

Constructor Detail

CListURLTemplateLinkMediator

public CListURLTemplateLinkMediator(AActivitySpace aspace,
                                    ICPListEntryIterator list)
Constructor for CListURLTemplateLinkMediator.

Parameters:
aspace - The current Activityspace
list - The ASCompoundlist used by this mediator
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
Overrides:
GetEntry in class CListURLTemplateMediator
Returns:
An HTMLAnchor with the URL Template as onclick action and poundsign as href. Also includes image if one is set on the link.
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
Overrides:
GetEntryAtIndex in class CListURLTemplateMediator
Parameters:
nIndex - Index of the entry
Returns:
An HTMLAnchor with the URL Template as onclick action and poundsign as href.
See Also:
ICPListIterator.GetEntry()



Copyright © 2002,2003,2004,2005 Plumtree Software, Inc., All Rights Reserved.