Get External Content

Get External Content

Within a JSF Widget Library (JWL) panel tag, this tag defines alternative content for the panel that can be asynchronously retrieved after the page has been loaded into the browser. The tag supports partial page reload.

Whenever a JWL get action is run against the component (for example, as the result of a button click), the client requests the alternative content for the panel and if it is available, replaces the existing content of the panel with the new content. The page containing the panel is not replaced by the get, instead, this tag allows part of the page to be replaced. The revised content for the page is retrieved from any source identifiable by a URL. The server lifecycle copy of the original page is not synchronized with changes made to the page. So this tag should only be used to add read-only content to the page, for example, to retrieve context-specific help information.

Allowed as Child Tag

The tag may be used as a child of the following tags:

<hx:panelActionbar>

<hx:panelBox>

<hx:panelDialog>

<hx:panelFormBox>

<h:panelGrid>

<h:panelGroup>

<hx:panelLayout>

<hx:panelMenu>

<hx:panelSection>

Allowed Contents

The tag rebuilds the content of a panel tag (allowed tags listed above). A panel that is being rebuilt may include any JSF tags except the following:

<hx:scriptCollector>

<f:subview>

<f:view>

<hx:viewFragment>

<hx:inputHelperFormTracker>

<hx:inputHelperSetFocus>

<r:inputRichText>

<odc:tabbedPanel>

<odc:bfPanel>

<odc:buttonPanel>

<odc:tree>

<odc:treeNodeAttr>

<odc:graphDraw>

<odc:graphDrawData>

<odc:graphDrawDataSeries>

<odc:graphDrawLabels>

Properties and All Attributes views

The Properties view for a component shows the most common set of attributes you can set on a component, and, depending on the component, you might also see options for adding controls, actions, or other components. To open the Properties view, click

Window | Show View | Properties.

The common attributes for the Get External Content component are listed in the table below.

The All Attributes view shows a table of all the attributes you can set on a component, which includes those attributes you can access from the Properties view. To switch to the All Attributes view, click the
All Attributes icon in the upper right corner of the Properties view.

Table 1. Get External Content component attributes

Attribute name

Description

binding

An expression that binds the component's instance (usually a user interface component) to a bean property (usually in the backing file).

charset

The character encoding of the resource designated by the hyperlink.

href

The URL of the JSP that responds to the request. When a JWL get action is issued against this component, the new content for the panel associated with the component is retrieved using the specified URL.

hreflang

The language code of the resource designated by this hyperlink.

id

Assigns a name to a component. Should be a unique name within a JSP.

inProgress

Attribute is not yet available.

rendered

Can be set to true or false:

false - Component will not be rendered to the browser at runtime.

true - Component will get rendered. This is the default value.

params

The value of these tags will be retrieved and appended as params to the URL used to get the new content. The name of the param will be the simple ID provided. For example, if the ID is "text1", the param will be named "text1" (not "form1:text1").

source

The IDof a tag in the targeted URL whose content will replace the content of the container with which this component is associated. If not specified or if the ID is not found in the page referenced by the URL, the ID of container is used. If this ID is not found in the page referenced by the URL, the body content is used.

target

Assigns the target frame within a frameset that a page should be loaded into when the hyperlink is clicked:

New Window

Same Frame

Parent Frame

Full Screen

title

Specifies the title text, shown in browser as a tooltip at runtime. Used by a browser as the alternative text of a component if the alternative text is not specified.

oncomplete

If a request succeeds, after the content of the panel is replaced, this JavaScript™ is executed. The function has no meaningful arguments.

onerror

If provided, a JavaScript function to be executed when onblur fires and the field value fails validation. The function is executed before the action is executed. If the function returns false, the action is not run and processing of the event is halted (if the DOM halts it).

onstart

When the behavior starts executing, this JavaScript function is executed. It has no meaningful arguments. If it returns false execution is halted. This function can be used (in conjunction with oncomplete to customize what is displayed while the request is in progress.

Attribute name	Description
binding	An expression that binds the component's instance (usually a user interface component) to a bean property (usually in the backing file).
charset	The character encoding of the resource designated by the hyperlink.
href	The URL of the JSP that responds to the request. When a JWL get action is issued against this component, the new content for the panel associated with the component is retrieved using the specified URL.
hreflang	The language code of the resource designated by this hyperlink.
id	Assigns a name to a component. Should be a unique name within a JSP.
inProgress	Attribute is not yet available.
rendered	Can be set to true or false: false - Component will not be rendered to the browser at runtime. true - Component will get rendered. This is the default value.
params	The value of these tags will be retrieved and appended as params to the URL used to get the new content. The name of the param will be the simple ID provided. For example, if the ID is "text1", the param will be named "text1" (not "form1:text1").
source	The IDof a tag in the targeted URL whose content will replace the content of the container with which this component is associated. If not specified or if the ID is not found in the page referenced by the URL, the ID of container is used. If this ID is not found in the page referenced by the URL, the body content is used.
target	Assigns the target frame within a frameset that a page should be loaded into when the hyperlink is clicked: New Window Same Frame Parent Frame Full Screen
title	Specifies the title text, shown in browser as a tooltip at runtime. Used by a browser as the alternative text of a component if the alternative text is not specified.
oncomplete	If a request succeeds, after the content of the panel is replaced, this JavaScript™ is executed. The function has no meaningful arguments.
onerror	If provided, a JavaScript function to be executed when onblur fires and the field value fails validation. The function is executed before the action is executed. If the function returns false, the action is not run and processing of the event is halted (if the DOM halts it).
onstart	When the behavior starts executing, this JavaScript function is executed. It has no meaningful arguments. If it returns false execution is halted. This function can be used (in conjunction with oncomplete to customize what is displayed while the request is in progress.