Encode Behavior

Render an HTML "input" element of type "button". The value of the component is rendered as the button text and the outcome of the component is used to determine the target URL which is activated by onclick. If "image" attribute is specified, render it as the value of the "src" attribute after passing it to the getResourceURL() method of the ViewHandler for this application, and passing the result through the encodeResourceURL() method of the ExternalContext.

If the component is not disabled, take the following actions.

Algorithm to obtain the url to which the user-agent should issue a GET request when clicked

Obtain the NavigationCase that corresponds to the component instance for this Renderer.

Obtain an instance of javax.faces.application.ConfigurableNavigationHandler from the ViewHandler. If no such instance can be obtained, write the "disabled" attribute on the button. Otherwise, let outcome be the result of calling getOutcome() on the argument component, which must be an instance of UIOutcomeTarget. If this result is null, let outcome be the viewId of the current UIViewRoot. Obtain a reference to the NavigationCase, called navCase for discussion. If the component has a non-null attribute named by the value of the symbolic constant javax.faces.event.ActionListener.TO_FLOW_DOCUMENT_ID_ATTR_NAME, let navCase be the return from calling getNavigationCase() on the ConfigurableNavigationHandler, passing the current FacesContext as the first argument, null, as the second argument, outcome as the third argument, and the value of the TO_FLOW_DOCUMENT_ID_ATTR_NAME attribute as the fourth argument. Otherwise, let navCase be the return from calling getNavigationCase() on the ConfigurableNavigationHandler, passing the current FacesContext as the first argument, null, as the second argument, and outcome as the third argument. If this returns null, log an informative error which includes the component id, and write the "disabled" attribute on the component markup, with the value of true. Otherwise obtain the encoded target URL using the following algorithm.

Algorithm to obtain the encoded target URL

• Let params be the Map<String, List<String>> to be passed to ViewHandler.getBookmarkableURL(). Build this map up first from any child UIParameter components. These children must be processed in the order in which they appear as children. If multiple children with the same name are encountered, their values must appear in the List<String> in the Map entry with the same name, and appear in the list in the same order as their child order.

• Obtain any parameters included within the navigation case. Call getParameters() on navCase. The result will be a Map<String, List<String>>. If the result is non-null and non-empty, iterate over the entries from the result Map and, if no entry with the same name exists in params, set the value from the current entry as the value in the params Map.

• If the navigation case has a non-null toFlowDocumentId property, add two parameters as shown in this table.

  parameter name	parameter value
  value of FlowHandler.TO_FLOW_DOCUMENT_ID_REQUEST_PARAM_NAME	value of the toFlowDocumentId property of the navigation case
  value of FlowHandler.FLOW_ID_REQUEST_PARAM_NAME	value of the fromOutcome property of the navigation case

• Let includeViewParams be the result of a logical OR of the results from calling isIncludeViewParams() on the argument UIOutcomeTarget component and calling isIncludeViewParams on navCase.

• Call getBookmarkableURL() on the ViewHandler, passing the current FacesContext as the first argument, the return from calling getToViewId() as the second argument, params as the third argument, and includeViewParams as the last argument.

The entire target URL string must be processed by a call to the encodeResourceURL() method of the ExternalContext. The name of the UIParameter goes on the left hand side, and the value of the UIParameter on the right hand side. The name and the value must be URLEncoded. Each UIParameter instance is separeted by an ampersand, as dictated in the URL spec. The final encoded result will be written out to the onclick attribute of the button as "window.location.href = ''". If the developer has specified a custom onlclick the window.location.href name/value pair will be appended at the end of the developer specified script. If the "fragment" attribute is specified, the value will be included at the end of the resulting URL preceded by a hash mark. If the "styleClass" attribute is specified, render its value as the value of the "class" attribute. If the "id" attribute is specified, follow the same steps as mentioned in the "General Notes on Encoding" regarding the "id" attribute for UIInput components. If the "disabled" attribute is specified, do not render the "onclick" element and assign the "disabled" attribute a value of true.