Module org.omnifaces

Package org.omnifaces.component.output

Class Link

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

jakarta.faces.component.UIOutput

jakarta.faces.component.UIOutcomeTarget

jakarta.faces.component.html.HtmlOutcomeTargetLink

org.omnifaces.component.output.Link

All Implemented Interfaces:

ClientBehaviorHolder, PartialStateHolder, StateHolder, TransientStateHolder, ValueHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder, EventListener

public class Link
extends HtmlOutcomeTargetLink

The <o:link> is a component that extends the standard <h:link> and allows including the request query string parameters of the current URL into the link's target URL. Standard Faces <h:link> does not include any query string parameters which are not declared as view parameters. This is particularly useful if you expect some state in the target page and don't want to repeat <f|o:param> all over place.

You can use it the same way as <h:link>, you only need to change h: to o:.

Include request params

When you want to include request query string parameters of the current URL into the link's target URL, set the includeRequestParams attribute to true.

 <o:link value="Go to some page with same query string" outcome="some-page" includeRequestParams="true">
 

Since:

4.5

Author:

Bauke Scholtz

See Also:

• ActionURLDecorator

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT_TYPE	The component type, which is "org.omnifaces.component.output.Link".

Fields inherited from class jakarta.faces.component.html.HtmlOutcomeTargetLink

COMPONENT_FAMILY

Fields inherited from class jakarta.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor	Description
Link()

Method Summary

Modifier and Type	Method	Description
void	encodeBegin(FacesContext context)
String	getFragment()	Returns the identifier of the page fragment which should be brought into focus when the target page is rendered.
boolean	isIncludeRequestParams()	Returns whether or not the request parameters should be encoded into the target URL.
void	setFragment(String fragment)	Sets the identifier of the page fragment which should be brought into focus when the target page is rendered.
void	setIncludeRequestParams(boolean includeRequestParams)	Sets whether or not the request parameters should be encoded into the target URL.

Methods inherited from class jakarta.faces.component.html.HtmlOutcomeTargetLink

addClientBehavior, getAccesskey, getCharset, getCoords, getDir, getEventNames, getFamily, getHreflang, getLang, getOnblur, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getRel, getRev, getRole, getShape, getStyle, getStyleClass, getTabindex, getTarget, getTitle, getType, isDisabled, setAccesskey, setCharset, setCoords, setDir, setDisabled, setHreflang, setLang, setOnblur, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setRel, setRev, setRole, setShape, setStyle, setStyleClass, setTabindex, setTarget, setTitle, setType, setValueExpression

Methods inherited from class jakarta.faces.component.UIOutcomeTarget

getOutcome, isDisableClientWindow, isIncludeViewParams, setDisableClientWindow, setIncludeViewParams, setOutcome

Methods inherited from class jakarta.faces.component.UIOutput

clearInitialState, getConverter, getLocalValue, getValue, markInitialState, resetValue, restoreState, saveState, setConverter, setValue

Methods inherited from class jakarta.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeAll, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, visitTree

Methods inherited from class jakarta.faces.component.UIComponent

getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jakarta.faces.component.behavior.ClientBehaviorHolder

getClientBehaviors, getDefaultEventName

Field Details

COMPONENT_TYPE

public static final String COMPONENT_TYPE

The component type, which is "org.omnifaces.component.output.Link".

See Also:

• Constant Field Values

Constructor Details

Link

public Link()

Method Details

encodeBegin

public void encodeBegin(FacesContext context)
                 throws IOException

Overrides:

encodeBegin in class UIComponentBase

Throws:

IOException

isIncludeRequestParams

public boolean isIncludeRequestParams()

Returns whether or not the request parameters should be encoded into the target URL. Defaults to false.

Returns:

Whether or not the request parameters should be encoded into the target URL.

setIncludeRequestParams

public void setIncludeRequestParams(boolean includeRequestParams)

Sets whether or not the request parameters should be encoded into the target URL. Defaults to false.

Parameters:

includeRequestParams - Whether or not the request parameters should be encoded into the target URL.

getFragment

public String getFragment()

Returns the identifier of the page fragment which should be brought into focus when the target page is rendered. The value of this attribute is appended to the end of target URL following a hash (#) mark. This notation is part of the standard URL syntax.

Returns:

The page fragment identifier.

setFragment

public void setFragment(String fragment)

Sets the identifier of the page fragment which should be brought into focus when the target page is rendered. The value of this attribute is appended to the end of target URL following a hash (#) mark. This notation is part of the standard URL syntax.

Parameters:

fragment - The page fragment identifier.