MWS Html - mws_h

Tag Library Information 
InfoValue
ID (tag prefix)mws_h
URIhttp://webmethods.com/jsf/mws/html
Tag Summary 
TagDescription
contextUpdater

Adds or modifies a workspace context. The Context Updater also examines the workspace for any portlets that are wired to the context and forces a refresh.

With this control on the page, the context property value can be changed from javascript like in the example below:

//This requires a control with the id of 'contextUpdater' to be present on the page as well as a valid 'value' variable
var updaterID = '#{caf:cid("contextUpdater")}';
Noodle.Context.updaters[updaterID].updateContext(value);

panelEmailMessage

Controls the information that is rendered for an email notification.

The child of the control, normally a Panel, becomes the contents of the email message. The child control has two extended CAF facets, subject and from.
panelRssMessage

A control that determines what information is rendered for RSS notification.

The RSS Message Panel includes three facets: title, link, and description. You must populate these facets using by controls.
peoplePickerDialog

A movable modal dialog that enables the user to select one or more principals: users, groups, or roles. Use the People Picker Dialog control to replace the deprecated Principal Picker Dialog control.

Note: This control is not portable to third-party portals. You can use it only in portlets published to instances of My webMethods Server.

The selected principals are referenced by the control's targetValue property. For a single-item select picker, the targetValue property binds to the following data types:

  • com.webmethods.caf.faces.data.dir.IPrincipalProvider - a model object that represents the principal
  • com.webmethods.portal.system.IURI - the My webMethods ServerID of the principal
  • java.lang.String - a string representation of the My webMethods Server ID of the principal

For a multi-select picker, the targetValue property binds to a list or array of the above types.

You can use the com.webmethods.caf.faces.data.dir.PrincipalModelFactory and com.webmethods.caf.faces.data.dir.PrincipalModelList classes to help create individual principal model objects or lists of principal model objects.

Like other visibility controls, this control toggles between visible and hidden through client-side JavaScript code. The toggle controls encapsulate this code within controls that you can visually create and configure using the Composite Application Framework. For more information, see information about concealable controls and toggle controls in the in the webMethods CAF Development Help.

peopleSearchBar

A search bar control used to search for users, groups, or roles.

This control is typically not used directy. Rather, this control is typically used by the People Picker Dialog control, which handles the fundamentals of wiring the People SearchBar to the People SwapBox and applying the selection to the target.

peopleSwapBox

A swap box control for choosing users, groups, or roles.

The selected principals are referenced by the control's targetValue property. For a single-select picker, the targetValue property binds to the following data types:

  • com.webmethods.caf.faces.data.dir.IPrincipalProvider - a model object that represents the principal
  • com.webmethods.portal.system.IURI - the My webMethods ServerID of the principal
  • java.lang.String - a string representation of the My webMethods Server ID of the principal

For a multi-select picker, the targetValue property binds to a list or array of the above types.

You can use the com.webmethods.caf.faces.data.dir.PrincipalModelFactory and com.webmethods.caf.faces.data.dir.PrincipalModelList classes to help create individual principal model objects or lists of principal model objects.

personCalendarDialog

A modal dialog that displays the user calendar for a specific person.

Like other visibility controls, this control toggles between visible and hidden through client-side JavaScript code. The toggle controls encapsulate this code within controls that you can visually create and configure using the Composite Application Framework. For more information, see information about concealable controls and toggle Controls in the webMethods CAF Development Help.

personProfileDialog

A modal dialog to display the profile for user, group or role.

Like other visibility controls, this control toggles between visible and hidden through client-side JavaScript code. The toggle controls encapsulate this code within controls that you can visually create and configure using the Composite Application Framework. For more information, see information about concealable controls and toggle Controls in the webMethods CAF Development Help.

portalResourcesPickerDialog

A modal dialog that enables the user to select one or more resources, such as folders, pages, and portlets.

This control is not portable to third-party portals. You can use it only in portlets published to instances of My webMethods Server.

The selected resources are referenced by the control's targetValue property. For a single-select picker, you can bind the targetValue property to the following data types:

  • com.webmethods.caf.faces.data.portal.PortalItemModel - A model object representing the My webMethods Server resource.
  • com.webmethods.portal.system.IURI - The My webMethods Server ID of the resource.
  • java.lang.String - Provides a string representation of the My webMethods Server ID of the resource.

For a multi-select picker, you can bind the targetValue attribute to a list or array of the above types.

Like other hideable controls, you can switch this control between visible and hidden through the use of client-side JavaScript code. Toggle controls encapsulate this code within controls that you can create and configure visually within CAF. For more information, see the topics "Hideable Controls" and "Toggle Controls" in the section "User Interface Controls Concepts" in the webMethods CAF Development Help.
portletEmbed

Embeds and renders in-place another portlet.

This control creates a distinct instance of a portlet that acts like a child of a portlet residing elsewhere. The Portlet Embed control reuses a portlet after it has created that portlet. Use a Portlet Include control when you need to create a unique instance of the embedded portlet.

The HTML content of the parent portlet is injected into the content of the embedded portlet. You can embed webMethods 6.5 (legacy) and 7.x and later portlet content using the Portlet Embed control.

Control Parameter controls added as children in the embedded portlet are used to pass preference values to the child portlet. The name of the parameter is the name of the preference, and the value of the parameter is the value of the preference set on the portlet to embed.

When embedding content of another portlet, if the parent portlet contains a form element, and you are embedding another portlet that also contains a form element, the embedded portlet might not function properly because HTML does not allow nested form elements.

Children

Control Parameter to specify preferences of the embedded portlet.

Use the Extended Portlet Parameter, com.webmethods.caf.faces.portleturl.ExtendedPortletUrlParameter, to specify parameters for this portlet URL.

Use com.webmethods.caf.faces.portleturl.ExtendedPortletUrl to add other portlet URLs when referencing multiple portlets.
portletInclude

Renders in-place another portlet.

This control dynamically embeds the content for an external portlet. The HTML content of the included portlet is injected into the content of the parent portlet. Both webMethods 6.5 (legacy) and 7.x and later portlet content may be included using Portlet Include.

Control Parameter controls added as children are used to pass preference values to the child portlet. The name of the parameter is the name of the preference, and the value of the parameter is the value of the preference set on the portlet to include.

When including content of a portlet in a portlet that has a form element, the included portlet might also use a form template, If this is the scenario, the included portlet might not function properly because HTML does not allow nested form elements.

Children

Control Parameter to specify preferences of the embedded portlet.
principalPickerDialog

WARNING: This tag has been deprecated. Replace with a People Picker Dialog control

A movable modal dialog that enables the user to select one or more principals: users, groups, or roles.

Note: This control is not portable to third-party portals. You can use it only in portlets published to instances of My webMethods Server.

The selected principals are referenced by the control's targetValue property. For a single-item select picker, the targetValue property binds to the following data types:

  • com.webmethods.caf.faces.data.dir.IPrincipalProvider - a model object that represents the principal
  • com.webmethods.portal.system.IURI - the My webMethods ServerID of the principal
  • java.lang.String - a string representation of the My webMethods Server ID of the principal

For a multi-select picker, the targetValue property binds to a list or array of the above types.

You can use the com.webmethods.caf.faces.data.dir.PrincipalModelFactory and com.webmethods.caf.faces.data.dir.PrincipalModelList classes to help create individual principal model objects or lists of principal model objects.

Like other visibility controls, this control toggles between visible and hidden through client-side JavaScript code. The toggle controls encapsulate this code within controls that you can visually create and configure using the Composite Application Framework. For more information, see information about concealable controls and toggle controls in the in the webMethods CAF Development Help.

scriptOpenAjax

Receives JavaScript Object Notation (JSON)-encoded events in the browser that have been initiated on the server.

Note: This control is not portable to third-party servers. You can use it only in portlets published to instances of My webMethods Server.

The developer configures the topic to listen to, and writes any server code that posts events to that topic. When an event is received in the browser, the event body is posted over the browser's Open Ajax Hub. The developer can either subscribe to the Open Ajax Topic, or create a callback JavaScript function directly to respond to the event.

Internally, the Open Ajax control makes a hidden request to the server to fetch any available events. This request is handled using non-blocking IO techniques and does not incur the typical performance penalty of polling, and also provides more immediate response times.

The callback JavaScript function includes: function(eventName, eventBody) {}. In this function, the eventName is the topic that the event was posted to, and the eventBody is the JSON representation of the posted event.

The following example demonstrates the Open Ajax control's callback function:

function (eventName, event) {
var eventText = 'A <em>' + eventName + '</em> event
was triggered by ' + event.user.fullName;
eventText += ' on the item ' + event.item.name;
alert(eventText);
}

To publish an event on the server, raise an object of type com.webmethods.event.impl.OpenAjaxEvent, as in the following:

new OpenAjaxEvent("com.mycompany.myproduct.mytopic", myobj).raise();

The object's toString< method should return a valid JSON string. Alternatively, you can repackage a subscribed CAF event.

The value attribute specifies the Javascript to invoke when receiving an event posted to the OpenAjaxTopic. Default: function(eventName, eventBody) {}
taskActionLink

A control that provides an output link that inherits most of the properties of the output Link control that you can use inside Task Notifications to initiate a Reply To email action on the task. When this link is used in the Task Notification, it creates a link inside the email body. Clicking this link creates a pre-filled reply email message, including To: email address, Subject, and body. A user can send it by using a native mail client like Outlook or Outlook Express.

Sending this email automatically performs a configured action on the task, for example, updating business data, like accept or not-accept, or completing a task, as configured on the control.

Children

Children of the email link can be used to define the look-and-feel of the link:

javax.faces.component.UIGraphic javax.faces.component.UIOutput

Output generated by Vdldoc View Declaration Language Documentation Generator.