url Taglib documentation

Tag encode url:encode(...)

URL encodes the given value.

Body Content: scriptless

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the URL encoded result.
value	false	true	java.lang.String
The value to URL encode.

↑

Tag decode url:decode(...)

URL decodes the given value.

Body Content: scriptless

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the URL decoded result.
value	false	true	java.lang.String
The value to URL decode.

↑

Tag approximate url:approximate(...)

Returns within 'urls' the best approximation for 'closeTo'. It will compare both the path and the query string of the URLs and returns the most accurate URLs within a collection.

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the best candidate.
items	true	true	java.util.List
A list of candidates URLs. Object of type List(String).
closeTo	false	true	java.lang.String
A URL to find approximation to. By default the current URL will be used.

Example

// create a list of URLs
&lt;list:new var="urls" /&gt;
&lt;list:add list="urls" add="page" /&gt;
&lt;list:add list="urls" add="page?param=value" /&gt;
&lt;list:add list="urls" add="page2" /&gt;
// retrieve the best approximation for the current url
&lt;url:approximate var="result" items="${urls}"&gt;
// handle result
&lt;c:forEach var="item" items="${urls}"
  &lt;c:if test="${result == item}"&gt;
    // selected url
  &lt;/c:if&gt;
&lt;/c:forEach&gt;

↑

Tag getPageName url:getPageName(...)

Returns the page name of the given URL.

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the page name.
url	false	true	java.lang.String
An URL to retrieve the page name from. By default the current URL is used.

↑

Tag resource url:resource(...)

Creates a URL for a file in the resource directory.

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the processed resource URL.
file	true	true	java.lang.String
The file path to process. It is relative to the resource directory.
testIfExists	false	true	boolean
Specifies if the given file existence should be tested. If it does not exists then NULL is returned. Defaults to "false".
dataWidgetWrapper	false	true	com.exalead.cv360.searchui.widgets.DataWidgetWrapper
The DataWidgetWrapper that contains the widgets to retrieve resource from. Defaults to the widget in the current context.

↑

Tag url url:url(...)

Creates a URL.

Body Content: scriptless

Attribute name	Required	Runtime Expression Evaluation	Type
var	false	false	java.lang.String
Name of the exported variable for the processed URL.
varPageName	false	false	java.lang.String
Name of the exported variable for the page name.
varParameters	false	false	java.util.Map
Name of the exported variable for the parameter list. Object of type Map(String, List(String)).
value	false	true	java.lang.String
The URL to be processed. It can be either relative or absolute.
keepQueryString	false	true	boolean
Specifies whether the URL should keep the current query string or not. Defaults to "false".
xmlEscape	false	false	boolean
Specifies whether the URL should be XML escaped or not. Defaults to "true".
feeds	false	true	java.util.Map
The ResultFeed to use for the URL creation. Object is of type Map(String, ResultFeed).
feed	false	true	com.exalead.access.feedapi.ResultFeed
The ResultFeed to use for the URL creation. Object is of type ResultFeed.

↑

Tag parameter url:parameter(...)

Adds or remove a parameter of the URL tag.

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
name	true	true	java.lang.String
Name of the query string parameter.
value	false	true	java.lang.String
Value of the parameter.
widget	false	true	com.exalead.cv360.searchui.configuration.v10.Widget
If set, the given parameter will be set for this widget. Use a ParameterAdapterWidgetTrigger to process this parameter.
override	false	true	boolean
Specifies whether the current query string parameter should be override or not. Defaults to "false".
urlEncode	false	true	boolean
Specifies whether the current query string parameter should be URL-encoded or not. Defaults to "true".

↑

Tag page url:page(...)

Sets the page parameter.

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
value	false	true	int
The new page number.

↑

Tag sort url:sort(...)

Sets a sort parameter.

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
expr	false	true	java.lang.String
The new sort expression, if empty it will try to retrieve the current sort expression.
reverseExpr	false	true	boolean
Reverse the sort expression either by clearing it or by switching between asc and desc if possible.
clear	false	true	boolean
Clears the sort parameters.

↑

Tag refine url:refine(...)

Sets a refine parameter.

Body Content: empty

Attribute name	Required	Runtime Expression Evaluation	Type
category	true	true	com.exalead.access.feedapi.AbstractCategory
The category to refine on.
forceState	false	true	java.lang.String
Force the refine state. The possible values are: "REFINED", "EXCLUDED" or "DISPLAYED".
forceRefineOn	false	true	java.util.List
A list of additional feeds name to refine.
zapRefinements	false	true	boolean
Specifies whether the refinements should be completely cancelled ("false") or only the last level ("true"). Defaults to "false".

↑

Function isUrl url:isUrl(...)

Returns whether the given string is a valid URL or not.

Function Class: com.exalead.cv360.searchui.view.jspapi.url.Functions

Function Signature: boolean isUrl(java.lang.String)

Example

			 < c:if test="${url:isUrl(entry.id)}" >