com.plumtree.uiinfrastructure.form
Class PassthruURL

java.lang.Object
  extended by com.plumtree.uiinfrastructure.form.PassthruURL
All Implemented Interfaces:
ILink, ILinkElement

public class PassthruURL
extends java.lang.Object
implements ILinkElement

This is a com.plumtree.uiinfrastructure.activityspace.ILink that works within an AFormAS. When clicked, the link will repost the form, then run the specified control with the provided args. Currently just a link within a single page; does not support setting an alternate space or display page.

Author:
CraigS

Constructor Summary
PassthruURL()
           
 
Method Summary
 void AddControlArgument(java.lang.String strName)
          This method allows you to add a control argument to the HTML URL with no value.
 void AddControlArgument(java.lang.String strName, boolean bValue)
          This method allows you to add a control argument to the HTML URL.
 void AddControlArgument(java.lang.String strName, int nValue)
          This method allows you to add a control argument to the HTML URL.
 void AddControlArgument(java.lang.String strName, java.lang.String strValue)
          This method allows you to add a control argument to the HTML URL.
 void AddControlArgument(java.lang.String strName, java.lang.String[] strValues)
          This method allows you to add a control argument to the HTML URL.
 void AddInnerHTMLElement(HTMLElement element)
           
 void AddInnerHTMLString(java.lang.String strHTML)
           
 HTMLElement GetURLAsHTMLElement()
           
 void SetControl(java.lang.String strControl)
           
 void SetDisplayPage(java.lang.String strPage)
           
 void SetLabelString(java.lang.String strLabel)
           
 boolean SetLinkCreateNewSpace(java.lang.String strSpace, AActivitySpace parent)
          This method creates a brand new AActivitySpace.
 boolean SetLinkGetCachedSpace(AActivitySpace space)
          This method takes a specific space and returns a link to that (including space ID).
 boolean SetLinkGetSpaceIfCached(java.lang.String strSpace, AActivitySpace parent)
          This method gets a named AActivitySpace from the cache if it is there, or creates a new one if it is not in the cache.
 boolean SetLinkToExternalURL(java.lang.String url)
           
 boolean SetSpaceGetCached(java.lang.String strSpace, java.lang.String strSpaceID)
           
 void SetSubSpaceKey(java.lang.String sSubSpaceKey)
          This method sets the sub space key.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PassthruURL

public PassthruURL()
Method Detail

AddControlArgument

public void AddControlArgument(java.lang.String strName,
                               java.lang.String strValue)
Description copied from interface: ILink
This method allows you to add a control argument to the HTML URL. Do not use this method to set arguments that already have their own methods, such as sub-space key, display page, and control. For HTTP URLs, strValue should be automatically URL encoded. The behavior when arguments are added with the same name is undefined. Sometimes it will overwrite the first name/value pair, and sometimes it will append the second name/value pair after the first. Arguments should not be added twice.

Specified by:
AddControlArgument in interface ILink
Parameters:
strName -
strValue -

AddControlArgument

public void AddControlArgument(java.lang.String strName,
                               java.lang.String[] strValues)
This method allows you to add a control argument to the HTML URL.

Specified by:
AddControlArgument in interface ILink
Parameters:
strName -
strValues -
See Also:
This URL encodes the value for you

AddControlArgument

public void AddControlArgument(java.lang.String strName,
                               int nValue)
This method allows you to add a control argument to the HTML URL.

Specified by:
AddControlArgument in interface ILink
Parameters:
strName -
nValue -
See Also:
ILink.AddControlArgument(String, String)

AddControlArgument

public void AddControlArgument(java.lang.String strName,
                               boolean bValue)
This method allows you to add a control argument to the HTML URL.

Specified by:
AddControlArgument in interface ILink
Parameters:
strName -
booleanValue -
See Also:
ILink.AddControlArgument(String, String)

AddControlArgument

public void AddControlArgument(java.lang.String strName)
This method allows you to add a control argument to the HTML URL with no value.

Specified by:
AddControlArgument in interface ILink
Parameters:
strName -
booleanValue -
See Also:
ILink.AddControlArgument(String, String)

AddInnerHTMLElement

public void AddInnerHTMLElement(HTMLElement element)
Specified by:
AddInnerHTMLElement in interface ILinkElement
Parameters:
element -

AddInnerHTMLString

public void AddInnerHTMLString(java.lang.String strHTML)
Specified by:
AddInnerHTMLString in interface ILinkElement
Parameters:
string -
Throws:
HTMLException

GetURLAsHTMLElement

public HTMLElement GetURLAsHTMLElement()
Specified by:
GetURLAsHTMLElement in interface ILinkElement
Returns:

SetControl

public void SetControl(java.lang.String strControl)
Specified by:
SetControl in interface ILink
Parameters:
strControl -

SetDisplayPage

public void SetDisplayPage(java.lang.String strPage)
Specified by:
SetDisplayPage in interface ILink
Parameters:
strPage -

SetLabelString

public void SetLabelString(java.lang.String strLabel)
Parameters:
string -

SetLinkCreateNewSpace

public boolean SetLinkCreateNewSpace(java.lang.String strSpace,
                                     AActivitySpace parent)
Description copied from interface: ILink
This method creates a brand new AActivitySpace.

Specified by:
SetLinkCreateNewSpace in interface ILink
Parameters:
strSpace -
parent -
Returns:

SetLinkGetCachedSpace

public boolean SetLinkGetCachedSpace(AActivitySpace space)
Description copied from interface: ILink
This method takes a specific space and returns a link to that (including space ID).

Specified by:
SetLinkGetCachedSpace in interface ILink
Parameters:
space -
Returns:

SetSpaceGetCached

public boolean SetSpaceGetCached(java.lang.String strSpace,
                                 java.lang.String strSpaceID)
Parameters:
strSpace -
strSpaceID -
Returns:

SetLinkGetSpaceIfCached

public boolean SetLinkGetSpaceIfCached(java.lang.String strSpace,
                                       AActivitySpace parent)
Description copied from interface: ILink
This method gets a named AActivitySpace from the cache if it is there, or creates a new one if it is not in the cache. This method should be used to get common AActivitySpaces such as MyPage and Community, not minor spaces like Tree and Editors. The SetLinkGetCachedSpace(AActivitySpace) should be used instead of this one when you can.

Specified by:
SetLinkGetSpaceIfCached in interface ILink
Parameters:
strSpace -
parent -
Returns:

SetSubSpaceKey

public void SetSubSpaceKey(java.lang.String sSubSpaceKey)
Description copied from interface: ILink
This method sets the sub space key. If this is not called, or is empty, the space will not be a sub-space. Otherwise it will be. The sub-space key is different from the space ID.

Specified by:
SetSubSpaceKey in interface ILink
Parameters:
sSubSpaceKey -

SetLinkToExternalURL

public boolean SetLinkToExternalURL(java.lang.String url)
Specified by:
SetLinkToExternalURL in interface ILink



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