Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.jalios.jcms.portlet
Class PortalManager

java.lang.Object
  extended by com.jalios.jcms.portlet.PortalManager

public final class PortalManager
extends Object

Manager for Portals that handle used classses, their associated images and manage lots of general features around PortalElement. The features are delegate to the portal element.

Version:
$Revision: 39481 $
Author:
Jean-Philippe Encausse

Nested Class Summary
static class PortalManager.CatDiscrimComparator
          This inner class compare two categories.
static class PortalManager.DisplayContextParameters
          A structure to handle method parameters
 
Field Summary
static String CSS_INNER
           
static String CSS_OUTER
           
static String HIGHLIGHT_DEFAULT_MODE
           
static String HIGHLIGHT_ENABLED
           
static String HIGHLIGHT_MODE
           
static String HIGHLIGHT_TEXT
           
static String PORTAL_ACTION
           
static String PORTAL_ACTION_CACHE
           
static String PORTAL_ACTION_CUT
           
static String PORTAL_ACTION_MODE
           
static String PORTAL_ACTION_PAST
           
static org.apache.oro.text.regex.Pattern PORTAL_ACTION_REGEXP
           
static String PORTAL_ACTION_REMOVE
           
static String PORTAL_AJAX_URI
           
static String PORTAL_CLIPBOARD
           
static String PORTAL_CONTEXTE_INCLUDE
           
static String PORTAL_CSS_DIRECTORY
           
static String PORTAL_CTXCATEGORIES
           
static String PORTAL_CURRENTCATEGORY
           
static String PORTAL_MODE_ENABLE
           
static String PORTAL_PORTAL
           
static String PORTAL_PORTALCATEGORY
           
static String PORTAL_PORTALELEMENT
           
static String PORTAL_PORTLET_FAKE
           
static String PORTAL_PUBLICATION
           
static String PORTAL_TEMPLATEUSAGE
           
static String REVISION
           
 
Constructor Summary
PortalManager()
           
 
Method Summary
static void addHighlightAttributes(javax.servlet.http.HttpServletRequest request, String text, String mode)
          Adds the given text and mode parameters as request attributes, and set the hlOk attribute to true to allow doDisplayHeader.jsp to provide highlight button.
static boolean canWorkOnSome(PortalInterface portal, Member loggedMember)
           
static boolean checkPortal(Category cat, DisplayContext context, Member loggedMember, boolean skipRedirect, boolean skipExact)
          This method looks for a matching Portal for a given Category.
protected static boolean checkPortal(Publication pub, DisplayContext context, Member loggedMember, boolean skipRedirect, boolean skipExact)
          Check the validity of the given Publication to be a convenient Portal.
protected static boolean checkPortal(Publication pub, DisplayContext context, Member loggedMember, boolean skipRedirect, boolean skipExact, boolean preview)
          Check the validity of the given Publication to be a convenient Portal.
static void clearHighlightAttributes(javax.servlet.http.HttpServletRequest request)
          Remove the highlight attributes from the current request to disable highlighting for the rest of the page
protected static boolean containsAction(javax.servlet.http.HttpServletRequest request, PortalElement portlet)
          Looking for an action in the HttpRequest
static boolean disableCache(javax.servlet.http.HttpServletRequest request, PortalElement portlet, Member loggedMember)
          Return true if the portlet should disable its cache Remove the cache parameter only if its the portlet itself that ask for a refresh (not one of it's parent)
static boolean findPortal(Category cat, DisplayContext context, Member loggedMember, boolean skipRedirect, boolean skipExact, boolean recursive)
          Recursive methode that try to find the right portal for a given category otherwise may call parent category.
static boolean findPortal(Publication pub, DisplayContext context, Member loggedMember, boolean skipRedirect, boolean skipExact, boolean preview, Category[] ctxCategories)
          Fill a display context with all the elements usefull for navigation, using the given steps:
1- Iterate on publication categories starting with sibling of contextual categories
2- Recursive call with parents until finding a Portal
3- Then set the portalCategory and the currentCategory
static String getActionParam(PortalElement portlet, String action)
          Return the parameter for an action of a Portlet
static String getAjaxPortalRedirect(javax.servlet.http.HttpServletRequest request)
          Build an URL working with in AjaxContext redirects
static String getAjaxPortalUrl(javax.servlet.http.HttpServletRequest request)
          Build an URL working with in AjaxContext redirects
static String getAjaxPortalUrl(PortalElement portlet)
          Deprecated. use #getAjaxPortalUrl()
protected static List getAllCategories(Collection categoryCollec)
          Return all categories at a given levels
static String getCacheParam(PortalElement portlet)
          Return the parameter for a cache of a Portlet
static File[] getCssFiles()
          This method return an array of CSS in directory css/portal.
static Map getCSSMap(String skinType, Class clazz)
           
static Category[] getCtxCategories(javax.servlet.http.HttpServletRequest request)
          Get all Categories from cid parameters in the request
static PortalInterface getDefaultPortal()
          Return the default portal according to the property channel.default-portal

Implementation note : since jcms-7.1.2, this default portal can be overrided by any custom PortalPolicyFilter.
See BasicPortalPolicyFilter#getDefaultPortal(PortalInterface, Member).
static DisplayContext getDisplayContext(JcmsContext context)
          This is a convenient method to compute display.jsp display context.
static DisplayContext getDisplayContext(String id, PortalInterface overrided, Category[] ctxCategories, Member loggedMember, boolean preview, String queryString)
          This method compute a display context of parameters for display.jsp.
static String getHightlightParams(javax.servlet.http.HttpServletRequest request)
          Build query string parameters from the information currently available in the request attributes.
static Category getHomeCategory()
          Return by default the Category associated to property channel.default-index.
static String getInnerClasses(PortalElement portlet)
          This method return classes to apply on the given portlet's inside.
static String getInnerStyles(PortalElement portlet)
          This method return style to apply on the given portlet's inside.
static String getOutterClasses(PortalElement portlet)
          This method return classes to apply on the given portlet's outside.
static String getOutterStyles(PortalElement portlet)
          This method return style to apply on the given portlet's outside.
static String getPermalink(Data data)
          Deprecated. user getPermalink(Data, Locale)
static String getPermalink(Data data, Locale locale)
          Returns an url representing the permanent link for the given data in the specified language.
static PortalInterface getPrintPortal()
          Return the print portal according to the property channel.default-printportal
static Category[] getRootNavigate()
           
static String getUrlWithCommonUpdatedParams(javax.servlet.http.HttpServletRequest request, String[] names, String[] values, boolean encodeParams)
           
static String getUrlWithUpdateCtxCategories(Category cat, Category[] ctxArray, javax.servlet.http.HttpServletRequest request, boolean ctx)
          Return an Url with updated cids
static String getUrlWithUpdateCtxCategories(Category cat, Category[] ctxArray, String resourcePath, Map parameterMap, boolean ctx)
          Return an Url with updated cids
static void handleDisplayRequest(JcmsJspContext context, DisplayContext display, long startPageRequest)
          Called by display.jsp to set all request attributes from computed display context.
static boolean handleRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Member loggedMember)
          Handle Request to check if parameters are Action of Portlets if true then remove them from request and put them to session.
static boolean hasFullDisplay(PortalElement portlet, Member loggedMember)
          Checks if there is a full display anywere inside the specified PortalElement (including the specified portlet itself).
static boolean isBehaviourBackCompatible()
          This method will check if the portal mecanic use the new behaviour or the old one.
static boolean isNewBehaviour()
          This method will check if the portal mecanic use the new behaviour or the old one.
static boolean isPreview(javax.servlet.http.HttpServletRequest request, PortalElement portlet)
          Return true if the portlet is in preview mode
static void printPortletException(javax.servlet.jsp.JspWriter out, Throwable ex, PortalElement portlet, org.apache.log4j.Logger portletLogger)
           
static void printPortletException(javax.servlet.jsp.JspWriter out, Throwable ex, String location, org.apache.log4j.Logger portletLogger)
           
static void processActions(javax.servlet.http.HttpServletRequest request, List portlets, Member loggedMember, List actions, List messages, List fullParams)
           
static String receiveAction(javax.servlet.http.HttpServletRequest request, PortalElement portlet, String action)
          Return a Message set for this Portlet by sendAction()
static boolean refreshCache(javax.servlet.http.HttpServletRequest request, PortalElement portlet, Member loggedMember)
          Return true if the portlet should refresh its cache Remove the cache parameter only if its the portlet itself that ask for a refresh (not one of it's parent)
static String removeAction(javax.servlet.http.HttpServletRequest request, PortalElement portlet, String action)
          Remove an action from the session.
static String sendAction(javax.servlet.http.HttpServletRequest request, PortalElement portlet, String action, String message)
          Return a well formated a URL with a paramameter to do an Action for the portlet
static void setPreview(javax.servlet.http.HttpServletRequest request, PortalElement portlet, boolean isPreview)
          Sets the portlet preview mode
protected static boolean updateFullDisplay(javax.servlet.http.HttpServletRequest request, PortalElement portlet, Member loggedMember)
          Looking for a FullDisplay Portlet
static void updateProperties()
          Init defaultPortal, homeCategory, printPortal and rootNavigate given following properties :
defaultPortal : based on channel.default-portal id property, or "j_193" if property not set. homeCategory : based on channel.default-index id property, or null if property not set. printPortal : based on channel.default-printportal id property, or "j_55" if property not set. rootNavigate : based on display.navigate-root ids property, or null if property not set.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

REVISION

public static final String REVISION
See Also:
Constant Field Values

PORTAL_ACTION

public static final String PORTAL_ACTION
See Also:
Constant Field Values

PORTAL_ACTION_REMOVE

public static final String PORTAL_ACTION_REMOVE
See Also:
Constant Field Values

PORTAL_ACTION_CACHE

public static final String PORTAL_ACTION_CACHE
See Also:
Constant Field Values

PORTAL_ACTION_MODE

public static final String PORTAL_ACTION_MODE
See Also:
Constant Field Values

PORTAL_PORTLET_FAKE

public static final String PORTAL_PORTLET_FAKE
See Also:
Constant Field Values

PORTAL_CSS_DIRECTORY

public static final String PORTAL_CSS_DIRECTORY
See Also:
Constant Field Values

PORTAL_ACTION_CUT

public static final String PORTAL_ACTION_CUT
See Also:
Constant Field Values

PORTAL_ACTION_PAST

public static final String PORTAL_ACTION_PAST
See Also:
Constant Field Values

PORTAL_ACTION_REGEXP

public static final org.apache.oro.text.regex.Pattern PORTAL_ACTION_REGEXP

PORTAL_MODE_ENABLE

public static final String PORTAL_MODE_ENABLE
See Also:
Constant Field Values

PORTAL_CLIPBOARD

public static final String PORTAL_CLIPBOARD
See Also:
Constant Field Values

PORTAL_PUBLICATION

public static final String PORTAL_PUBLICATION
See Also:
Constant Field Values

PORTAL_PORTALELEMENT

public static final String PORTAL_PORTALELEMENT
See Also:
Constant Field Values

PORTAL_PORTAL

public static final String PORTAL_PORTAL
See Also:
Constant Field Values

PORTAL_CURRENTCATEGORY

public static final String PORTAL_CURRENTCATEGORY
See Also:
Constant Field Values

PORTAL_PORTALCATEGORY

public static final String PORTAL_PORTALCATEGORY
See Also:
Constant Field Values

PORTAL_CTXCATEGORIES

public static final String PORTAL_CTXCATEGORIES
See Also:
Constant Field Values

PORTAL_TEMPLATEUSAGE

public static final String PORTAL_TEMPLATEUSAGE
See Also:
Constant Field Values

PORTAL_CONTEXTE_INCLUDE

public static final String PORTAL_CONTEXTE_INCLUDE
See Also:
Constant Field Values

PORTAL_AJAX_URI

public static final String PORTAL_AJAX_URI
See Also:
Constant Field Values

HIGHLIGHT_ENABLED

public static final String HIGHLIGHT_ENABLED
See Also:
Constant Field Values

HIGHLIGHT_TEXT

public static final String HIGHLIGHT_TEXT
See Also:
Constant Field Values

HIGHLIGHT_MODE

public static final String HIGHLIGHT_MODE
See Also:
Constant Field Values

HIGHLIGHT_DEFAULT_MODE

public static final String HIGHLIGHT_DEFAULT_MODE
See Also:
Constant Field Values

CSS_INNER

public static final String CSS_INNER
See Also:
Constant Field Values

CSS_OUTER

public static final String CSS_OUTER
See Also:
Constant Field Values
Constructor Detail

PortalManager

public PortalManager()
Method Detail

getActionParam

public static String getActionParam(PortalElement portlet,
                                    String action)
Return the parameter for an action of a Portlet

Parameters:
portlet -
Returns:
String
Since:
jcms-4.0

sendAction

public static String sendAction(javax.servlet.http.HttpServletRequest request,
                                PortalElement portlet,
                                String action,
                                String message)
Return a well formated a URL with a paramameter to do an Action for the portlet

Parameters:
request -
portlet -
action -
message -
Returns:
String
Since:
jcms-4.0

receiveAction

public static String receiveAction(javax.servlet.http.HttpServletRequest request,
                                   PortalElement portlet,
                                   String action)
Return a Message set for this Portlet by sendAction()

Parameters:
request -
portlet -
Returns:
Sting
Since:
jcms-4.0

removeAction

public static String removeAction(javax.servlet.http.HttpServletRequest request,
                                  PortalElement portlet,
                                  String action)
Remove an action from the session. Do not change the cache

Parameters:
request -
portlet -
action -
Since:
jcms-4.0 TODO: Refresh Cache Boolean

processActions

public static void processActions(javax.servlet.http.HttpServletRequest request,
                                  List portlets,
                                  Member loggedMember,
                                  List actions,
                                  List messages,
                                  List fullParams)

getUrlWithCommonUpdatedParams

public static String getUrlWithCommonUpdatedParams(javax.servlet.http.HttpServletRequest request,
                                                   String[] names,
                                                   String[] values,
                                                   boolean encodeParams)
Parameters:
request - the current HttpRequest
names - an array of parameter names added or updated the url
values - an array of values added or updated the url corresponding to names
encodeParams - whether to do a encodeURL on given param (if false, don't forget to do the encodeURL yourself on the parameters which need it! it is provided as a performance boost because encodeURL can be slow)
Returns:
Returns a relative URL with the given parameters added or updated plus common parameters: portal, id, portlet, jsp, cid if they are in the current request parameters

handleRequest

public static boolean handleRequest(javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response,
                                    Member loggedMember)
                             throws IOException
Handle Request to check if parameters are Action of Portlets if true then remove them from request and put them to session.

Parameters:
request -
response -
loggedMember -
Returns:
boolean
Throws:
IOException
Since:
jcms-4.0

getPermalink

public static String getPermalink(Data data)
Deprecated. user getPermalink(Data, Locale)

Returns an url representing the permanent link for the given data.

Parameters:
data - the data to work with
Returns:
String an url

getPermalink

public static String getPermalink(Data data,
                                  Locale locale)
Returns an url representing the permanent link for the given data in the specified language.

Parameters:
data - the data to work with
locale - the Locale in which the data is to be access by the permalink
Returns:
String an url

getCacheParam

public static String getCacheParam(PortalElement portlet)
Return the parameter for a cache of a Portlet

Parameters:
portlet -
Returns:
String
Since:
jcms-4.0

refreshCache

public static boolean refreshCache(javax.servlet.http.HttpServletRequest request,
                                   PortalElement portlet,
                                   Member loggedMember)
Return true if the portlet should refresh its cache Remove the cache parameter only if its the portlet itself that ask for a refresh (not one of it's parent)

Parameters:
request -
portlet -
Returns:
boolean
Since:
jcms-4.0

disableCache

public static boolean disableCache(javax.servlet.http.HttpServletRequest request,
                                   PortalElement portlet,
                                   Member loggedMember)
Return true if the portlet should disable its cache Remove the cache parameter only if its the portlet itself that ask for a refresh (not one of it's parent)

Parameters:
request -
portlet -
Returns:
boolean
Since:
jcms-4.0.1

containsAction

protected static boolean containsAction(javax.servlet.http.HttpServletRequest request,
                                        PortalElement portlet)
Looking for an action in the HttpRequest

Parameters:
request -
portlet -
Returns:
true if the request contains a Portlet Action

updateFullDisplay

protected static boolean updateFullDisplay(javax.servlet.http.HttpServletRequest request,
                                           PortalElement portlet,
                                           Member loggedMember)
Looking for a FullDisplay Portlet

Parameters:
request -
portlet -
loggedMember -
Returns:
true if a FullDisplay Portlet Exists and paremeter exists TODO: Control Customized Portlets

hasFullDisplay

public static boolean hasFullDisplay(PortalElement portlet,
                                     Member loggedMember)
Checks if there is a full display anywere inside the specified PortalElement (including the specified portlet itself).

Parameters:
portlet - the portlet from which to start FullDisplay search
loggedMember - the current loggedMember
Returns:
true if the specified portlet is a FullDisplay or if any of its children is a full display, false otherwise

isPreview

public static boolean isPreview(javax.servlet.http.HttpServletRequest request,
                                PortalElement portlet)
Return true if the portlet is in preview mode

Parameters:
request -
portlet -
Returns:
boolean
Since:
jcms-4.0

setPreview

public static void setPreview(javax.servlet.http.HttpServletRequest request,
                              PortalElement portlet,
                              boolean isPreview)
Sets the portlet preview mode

Parameters:
request -
portlet -
isPreview - (true to set it, false to remove)
Since:
jcms-6.0

canWorkOnSome

public static boolean canWorkOnSome(PortalInterface portal,
                                    Member loggedMember)

getDefaultPortal

public static PortalInterface getDefaultPortal()
Return the default portal according to the property channel.default-portal

Implementation note : since jcms-7.1.2, this default portal can be overrided by any custom PortalPolicyFilter.
See BasicPortalPolicyFilter#getDefaultPortal(PortalInterface, Member).

Returns:
the default Portal
Since:
jcms-4.1

getPrintPortal

public static PortalInterface getPrintPortal()
Return the print portal according to the property channel.default-printportal

Returns:
the print Portal
Since:
jcms-5.0.0

getHomeCategory

public static Category getHomeCategory()
Return by default the Category associated to property channel.default-index.

Implementation note : since jcms-7.1.2, this default home Category can be overrided by any custom PortalPolicyFilter.
See BasicPortalPolicyFilter#getHomeCategory(Category, Member).

Returns:
the home Category of the current logged Member.

getRootNavigate

public static Category[] getRootNavigate()
Returns:
an array of Categories bound to property display.navigate-root, or null.

updateProperties

public static void updateProperties()
Init defaultPortal, homeCategory, printPortal and rootNavigate given following properties :

findPortal

public static boolean findPortal(Publication pub,
                                 DisplayContext context,
                                 Member loggedMember,
                                 boolean skipRedirect,
                                 boolean skipExact,
                                 boolean preview,
                                 Category[] ctxCategories)
Fill a display context with all the elements usefull for navigation, using the given steps:
1- Iterate on publication categories starting with sibling of contextual categories
2- Recursive call with parents until finding a Portal
3- Then set the portalCategory and the currentCategory

Parameters:
pub - the publication to display
context - the display to fill
loggedMember - the member, the publication is displayed for
skipRedirect - should we ignore PortalRedirect ?
skipExact - should we ignore exact portal ?
preview - are we in preview mode ?
ctxCategories - the contextual categories to sort the iteration on publication categories
Returns:
true if the portal has been found

findPortal

public static boolean findPortal(Category cat,
                                 DisplayContext context,
                                 Member loggedMember,
                                 boolean skipRedirect,
                                 boolean skipExact,
                                 boolean recursive)
Recursive methode that try to find the right portal for a given category otherwise may call parent category. Work with an display context filled with navigation elements:

Parameters:
cat - the category to work with
context - the list to fill
loggedMember - the member, the publication is displayed for
skipRedirect - should we ignore PortalRedirect ? Usefull when called by findPortal(Publication).
skipExact - should we ignore portal accepting only exact match
recursive - is it a recursive call with parent category ?
Returns:
true if the portal has been found

checkPortal

public static boolean checkPortal(Category cat,
                                  DisplayContext context,
                                  Member loggedMember,
                                  boolean skipRedirect,
                                  boolean skipExact)

This method looks for a matching Portal for a given Category. Then set the portal Category in display context.

Portal with ExactCategory option are priority checked

Parameters:
cat - The current category
context - display context
loggedMember - The current member
skipRedirect - Should skip redirect portal
skipExact - Should skip exact portal
Since:
jcms-4.0

checkPortal

protected static boolean checkPortal(Publication pub,
                                     DisplayContext context,
                                     Member loggedMember,
                                     boolean skipRedirect,
                                     boolean skipExact)
Check the validity of the given Publication to be a convenient Portal.
Set the Portal.

Returns:
true if publication is validated
Since:
jcms-4.0

checkPortal

protected static boolean checkPortal(Publication pub,
                                     DisplayContext context,
                                     Member loggedMember,
                                     boolean skipRedirect,
                                     boolean skipExact,
                                     boolean preview)
Check the validity of the given Publication to be a convenient Portal.

Returns:
true if publication is validated
Since:
jcms-4.0

getAllCategories

protected static List getAllCategories(Collection categoryCollec)
Return all categories at a given levels

Since:
jcms-4.0

getCtxCategories

public static Category[] getCtxCategories(javax.servlet.http.HttpServletRequest request)
Get all Categories from cid parameters in the request

Parameters:
request - the current request
Returns:
An Array of category
Since:
jcms-5.0

getUrlWithUpdateCtxCategories

public static String getUrlWithUpdateCtxCategories(Category cat,
                                                   Category[] ctxArray,
                                                   String resourcePath,
                                                   Map parameterMap,
                                                   boolean ctx)
Return an Url with updated cids

Parameters:
cat - the category
ctxArray - the contextual category array
resourcePath - the request resource path
parameterMap - the request parameter map
ctx - is sctx category or navigate category
Returns:
a erlative Url
Since:
jcms-5.5

getUrlWithUpdateCtxCategories

public static String getUrlWithUpdateCtxCategories(Category cat,
                                                   Category[] ctxArray,
                                                   javax.servlet.http.HttpServletRequest request,
                                                   boolean ctx)
Return an Url with updated cids

Parameters:
cat - the category
ctxArray - the contextual category array
request - the request to call ServletUtil
ctx - is sctx category or navigate category
Returns:
a erlative Url
Since:
jcms-5.0

getDisplayContext

public static DisplayContext getDisplayContext(JcmsContext context)
This is a convenient method to compute display.jsp display context. See getDisplayContext() for more informations.

Parameters:
context - the JcmsContext
Returns:
List computed display context
See Also:
getDisplayContext(String, PortalInterface, Category[], Member, boolean, String)

getDisplayContext

public static DisplayContext getDisplayContext(String id,
                                               PortalInterface overrided,
                                               Category[] ctxCategories,
                                               Member loggedMember,
                                               boolean preview,
                                               String queryString)
This method compute a display context of parameters for display.jsp. The algorithm work on parameter 'id' to find matching attributes: CurrentCategory, PortalCategory, Portal to display the given Data.
- If context is null then a sendForbidden() must be called
- If redirect not null then sendRedirect()

Parameters:
id - the request parameter id describing the working data
overrided - the overrided portal (request parameter portal)
ctxCategories - the contextual categories (request parameter cid)
loggedMember - the loggedmember
preview - boolean indicate if it is a preview
queryString - the request querystring used by redirect parameters
Returns:
List of display.jsp computed parameters

handleDisplayRequest

public static void handleDisplayRequest(JcmsJspContext context,
                                        DisplayContext display,
                                        long startPageRequest)
Called by display.jsp to set all request attributes from computed display context. The method getDisplayContext() must be called before to compute display context.

Parameters:
context - a JcmsContext handling page request
display - a computed display.jsp display context
startPageRequest - long indicating start page request
See Also:
getDisplayContext(String, PortalInterface, Category[], Member, boolean, String)

addHighlightAttributes

public static void addHighlightAttributes(javax.servlet.http.HttpServletRequest request,
                                          String text,
                                          String mode)
Adds the given text and mode parameters as request attributes, and set the hlOk attribute to true to allow doDisplayHeader.jsp to provide highlight button.

Parameters:
request -
text - The text to highlight
mode - the mode to use to search the text (same mode used in query, all, any, etc)

clearHighlightAttributes

public static void clearHighlightAttributes(javax.servlet.http.HttpServletRequest request)
Remove the highlight attributes from the current request to disable highlighting for the rest of the page

getHightlightParams

public static String getHightlightParams(javax.servlet.http.HttpServletRequest request)
Build query string parameters from the information currently available in the request attributes. If highlight attributes are available in the request, the return value will be of the form "&hlText=...&hlMode=..."

getAjaxPortalUrl

@Deprecated
public static String getAjaxPortalUrl(PortalElement portlet)
Deprecated. use #getAjaxPortalUrl()

Build an URL working with AjaxContext redirects

Parameters:
portlet - the Portlet to display
Returns:
String a valid URL
Since:
jcms-6.0.1

getAjaxPortalUrl

public static String getAjaxPortalUrl(javax.servlet.http.HttpServletRequest request)
Build an URL working with in AjaxContext redirects

Parameters:
request - the HttpServletRequest
Returns:
String a valid URL
Since:
jcms-6.0.2

getAjaxPortalRedirect

public static String getAjaxPortalRedirect(javax.servlet.http.HttpServletRequest request)
Build an URL working with in AjaxContext redirects

Parameters:
request - the HttpServletRequest
Returns:
String a valid URL
Since:
jcms-6.0.2

isNewBehaviour

public static boolean isNewBehaviour()
This method will check if the portal mecanic use the new behaviour or the old one.

Returns:
boolean true if it is the new mecanic.
Since:
jcms-5.5.0

isBehaviourBackCompatible

public static boolean isBehaviourBackCompatible()
This method will check if the portal mecanic use the new behaviour or the old one.

Returns:
boolean true if it is the new mecanic.
Since:
jcms-5.5.0

getOutterStyles

public static String getOutterStyles(PortalElement portlet)
This method return style to apply on the given portlet's outside. It works with portlet attributes:

Parameters:
portlet - a PortalElement to work with
Returns:
String the outter styles
Since:
jcms-5.5.0

getInnerStyles

public static String getInnerStyles(PortalElement portlet)
This method return style to apply on the given portlet's inside. It works with portlet attributes:

Parameters:
portlet - a PortalElement to work with
Returns:
String the inner styles
Since:
jcms-5.5.0

getOutterClasses

public static String getOutterClasses(PortalElement portlet)
This method return classes to apply on the given portlet's outside. It may sets:

Parameters:
portlet - a PortalElement to work with
Returns:
String the outer classes
Since:
jcms-5.5.0

getInnerClasses

public static String getInnerClasses(PortalElement portlet)
This method return classes to apply on the given portlet's inside. It works with portlet attributes:

Parameters:
portlet - a PortalElement to work with
Returns:
String the inner classes
Since:
jcms-5.5.0

getCssFiles

public static File[] getCssFiles()
This method return an array of CSS in directory css/portal. It is used by portal to display available portal css files.

Returns:
File[] the list of css files

getCSSMap

public static Map getCSSMap(String skinType,
                            Class clazz)

printPortletException

public static void printPortletException(javax.servlet.jsp.JspWriter out,
                                         Throwable ex,
                                         PortalElement portlet,
                                         org.apache.log4j.Logger portletLogger)
                                  throws IOException
Throws:
IOException

printPortletException

public static void printPortletException(javax.servlet.jsp.JspWriter out,
                                         Throwable ex,
                                         String location,
                                         org.apache.log4j.Logger portletLogger)
                                  throws IOException
Throws:
IOException
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2001-2010 Jalios SA. All Rights Reserved.