UI components XML reference

This reference describes the elements and attributes through which you can UI components to Jive SBS. You use the elements described here in a plugin.xml file.

Many of the attributes have alternatives as elements, and vice versa. This is to support including special markup in CDATA sections (which you can't do in attribute values). For example, you could include Struts tags or Java method calls as the value of the name, when, or url elements.

For more information about plugin.xml file, see Plugin XML reference. For examples, see Integrating action user interface.

<component> element

Defines a piece of user interface for inclusion in Jive SBS. Use the id attribute to specify just where the component should show up in the UI. 

<component
  id="admin-console | blog-actions | community-actions | 
  community-tabs | document-actions | image-picker-tabs | 
  profile-actions | profile-actions-self | profile-overview-content | 
  thread-actions | user-bar | user-profile | 
  project-actions | project-tabs">
  <name>
  <description>
  <url>
  <when>
  <cssClass>
  <style>
  <onclick>
  <include>
  <tab>
  <hide>
</component>

Attributes

id
Identifies the part of the Jive SBS UI this component is integrating with. This value must be one of a finite set of values Jive SBS recognizes. You'll find more about these values in Integrating Plugin UI.

<components> element

Top-level element defining one or more user interface components. This element must be a child of the <plugin> element described in the plugin XML reference.

<components>
  <component>
</components>

<cssClass> element

The CSS class that styles this UI element.

<cssClass>xs:string</cssClass>

<description> element

Tooltip text for the UI element.

<description>xs:string</description>

<hide> element

Hides the UI element specified by its id attribute value.

<hide
  id="xs:string" />

Attributes

id
The UI element to hide.

<include> element

Content that should be included in this item. This is used instead of the url option, they should not be used together.

<include>xs:string</include>

<item> element

Adds a link on the page corresponding to a second-level tab in the Admin Console.

<item
  id="xs:string"
  name="xs:string"
  description="xs:string"
  url="xs:string"
  module="xs:string"
  edition="forums | blogs | wiki"
  role="systemAdmin | groupAdmin | userAdmin | communityAdmin"
  accesskey="xs:string"
  cssClass="xs:string"
  style="xs:string"
  onclick="xs:string"
  visible="xs:string"
  include="xs:string">
  <name>
  <description>
  <url>
  <when>
  <cssClass>
  <style>
  <onclick>
  <include>
  <section>
</item>

Attributes

id
The unique id for this node. This id only needs to be unique within its component. This id is often, but not necessarily used for an html id.
name
The name of this node. This name should be specified if it is the first time the element is being specified. If you are trying to override behavior for an element there is no need to specify its name, just its id (unless you whish to change the the name of the node).
description
A description of this node. This is often used in tooltips or as a short description below the node in the ui.
url
A URL to the Struts action that should be executed by the UI element.
module
Specifies the Jive SBS module (feature) that must be present for this UI item to be used.
edition
Whether or not this item shows up, depending on edition of the product. Valid values are 'internal' and 'external'. If nothing is specified the item will appear in either edition. Currently this attribute is only respected in the Admin Console.
role
Specifies the administrator roles for which this component will be visible.
accesskey
The keystroke that activates this UI element.
cssClass
The CSS class that styles this UI element.
style
A style rule associated with this UI element -- for example, display:none
onclick
Javascript to execute for this UI element.
visible
If this is set to true the element will not be visible. This is generally not manipulated directly, but rather through the use of a hide element in a plugin.
include
Content that should be included in this item. This is used instead of the url option, they should not be used together.

<name> element

The text that should appear for the UI element.

<name>xs:string</name>

<onclick> element

Javascript to execute for this UI element.

<onclick>xs:string</onclick>

<section> element

Adds a second-level tab to an Admin Console page.

<section
  id="xs:string"
  name="xs:string"
  description="xs:string"
  url="xs:string"
  module="xs:string"
  edition="xs:string"
  role="systemAdmin | groupAdmin | userAdmin | communityAdmin"
  accesskey="xs:string"
  cssClass="xs:string"
  style="xs:string"
  onclick="xs:string"
  visible="xs:string"
  include="xs:string">
  <name>
  <description>
  <url>
  <when>
  <cssClass>
  <style>
  <onclick>
  <include>
  <item>
</section>

Attributes

id
The unique id for this node. This id only needs to be unique within its component. This id is often, but not necessarily used for an html id.
name
The name of this node. This name should be specified if it is the first time the element is being specified. If you are trying to override behavior for an element there is no need to specify its name, just its id (unless you whish to change the the name of the node).
description
A description of this node. This is often used in tooltips or as a short description below the node in the ui.
url
A URL to the Struts action that should be executed by the UI element.
module
edition
Whether or not this item shows up, depending on edition of the product. Valid values are 'internal' and 'external'. If nothing is specified the item will appear in either edition. Currently this attribute is only respected in the Admin Console.
role
Specifies the administrator roles for which this component will be visible.
accesskey
The keystroke that activates this UI element.
cssClass
The CSS class that styles this UI element.
style
A style rule associated with this UI element -- for example, display:none
onclick
Javascript to execute for this UI element.
visible
If this is set to true the element will not be visible. This is generally not manipulated directly, but rather through the use of a hide element in a plugin.
include
Content that should be included in this item. This is used instead of the url option, they should not be used together.

<style> element

A style rule associated with this UI element -- for example, display:none

<style>xs:string</style>

<tab> element

Most often this is rendered as a tab on the page. In places where there is not really a concept of multiple tabs it is just the top level UI item holder. 

<tab
  id="xs:string"
  name="xs:string"
  description="xs:string"
  url="xs:string"
  module="xs:string"
  edition="xs:string"
  role="systemAdmin | groupAdmin | userAdmin | communityAdmin"
  accesskey="xs:string"
  cssClass="xs:string"
  style="xs:string"
  onclick="xs:string"
  visible="xs:string"
  include="xs:string">
  <name>
  <description>
  <url>
  <when>
  <cssClass>
  <style>
  <onclick>
  <include>
  <section>
  <item>
</tab>

Attributes

id
The unique id for this node. This id only needs to be unique within its component. This id is often, but not necessarily used for an html id.
name
The name of this node. This name should be specified if it is the first time the element is being specified. If you are trying to override behavior for an element there is no need to specify its name, just its id (unless you whish to change the the name of the node).
description
A description of this node. This is often used in tooltips or as a short description below the node in the ui.
url
A URL to the Struts action that should be executed by the UI element.
module
edition
Whether or not this item shows up, depending on edition of the product. Valid values are 'internal' and 'external'. If nothing is specified the item will appear in either edition. Currently this attribute is only respected in the Admin Console.
role
Specifies the administrator roles for which this component will be visible.
accesskey
The keystroke that activates this UI element.
cssClass
The CSS class that styles this UI element.
style
A style rule associated with this UI element -- for example, display:none
onclick
Javascript to execute for this UI element.
visible
If this is set to true the element will not be visible. This is generally not manipulated directly, but rather through the use of a hide element in a plugin.
include
Content that should be included in this item. This is used instead of the url option, they should not be used together.

<url> element

A URL to the Struts action that should be executed by the UI element.

<url>xs:string</url>

<when> element

Specifies a condition that must be met in order for the UI element to be displayed.

<when>xs:string</when>