Home » displaytag-1.1.1-src » org » displaytag » portlet » [javadoc | source]
org.displaytag.portlet
public class: PortletHref [javadoc | source]
java.lang.Object
   org.displaytag.portlet.PortletHref

All Implemented Interfaces:
    Href

Implementation of the Href interface that generates URLs using the javax.portlet APIs. As the portlet API supports the concept of WindowStates, PorletModes, secure URLs and actions versus render the implementation supports these concepts as well through the standard Href APIs.

The features are manipulated using special parameter names and values:
Feature Parameter Name Parameter Value
Render vs Action URL #PARAM_TYPE (portlet:type) "render" for RenderURLs, "action" for ActionURLs
WindowState #PARAM_STATE (portlet:state) The value is used directly for the WindowState name
PorltetMode #PARAM_MODE (portlet:mode) The value is used directly for the PortletMode name
Secure URL #PARAM_SECURE (portlet:secure) "true" requests a secure URL, anything else requests a standard URL
Field Summary
public static final  String PARAM_MODE     
public static final  String PARAM_STATE     
public static final  String PARAM_SECURE     
public static final  String PARAM_TYPE     
public static final  String TYPE_RENDER     
public static final  String TYPE_ACTION     
Constructor:
 public PortletHref(PortletRequest portletRequest,
    RenderResponse renderResponse) 
    Creates a new PortletHref. The actual PortletURL object is not generated until the toString method is called.
    Parameters:
    portletRequest - request to to feature checking with, may not be null.
    renderResponse - response to generate the URLs from, may not be null.
Method from org.displaytag.portlet.PortletHref Summary:
addParameter,   addParameter,   addParameterMap,   clone,   equals,   getAnchor,   getBaseUrl,   getParameterMap,   getRequestedMode,   getRequestedState,   hashCode,   isAction,   isRequestedSecure,   removeParameter,   setAction,   setAnchor,   setFullUrl,   setParameterMap,   setRequestedMode,   setRequestedSecure,   setRequestedState,   toString
Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.displaytag.portlet.PortletHref Detail:
 public Href addParameter(String name,
    int value) 
 public Href addParameter(String name,
    Object objValue) 
 public  void addParameterMap(Map parametersMap) 
 public Object clone() 
 public boolean equals(Object object) 
 public String getAnchor() 
 public String getBaseUrl() 
    Generates a render or action URL depending on the use of the PortletUrl specific features of this class.
 public Map getParameterMap() 
    Warning, parameters added to the Map directly will not be parsed by the PortletUrl feature support portions of this class.
 public PortletMode getRequestedMode() 
 public WindowState getRequestedState() 
 public int hashCode() 
 public boolean isAction() 
 public boolean isRequestedSecure() 
 public  void removeParameter(String name) 
 public  void setAction(boolean isAction) 
 public  void setAnchor(String name) 
 public  void setFullUrl(String baseUrl) 
 public  void setParameterMap(Map parametersMap) 
 public  void setRequestedMode(PortletMode requestedMode) 
 public  void setRequestedSecure(boolean requestedSecure) 
 public  void setRequestedState(WindowState requestedState) 
 public String toString()