complexType "dat:ButtonBarItem"
Namespace:
http://labkey.org/data/xml
Content:
complex, 12 attributes, 4 elements
Defined:
globally in tableInfo.xsd, see XML source
Includes:
definitions of 12 attributes and 4 elements
Used:
at 1 location
XML Representation Summary
<...
    hidden
 = 
 xs:boolean
    iconCls
 = 
 xs:string
    insertAfter
 = 
 xs:string
    insertBefore
 = 
 xs:string
    insertPosition
 = 
 (xs:int | ("beginning" | "end"))
    permission
 = 
 ("READ" | "INSERT" | "UPDATE" | "DELETE" | "ADMIN")
    permissionClass
 = 
 xs:string
    requiresSelection
 = 
 xs:boolean
    requiresSelectionMaxCount
 = 
 xs:int
    requiresSelectionMinCount
 = 
 xs:int
    suppressWarning
 = 
 xs:boolean
    text
 = 
 xs:string
    >
   
Content: 
 dat:target | dat:onClick | dat:item+ | dat:originalText
</...>
Content Model Elements (4):
dat:item (type dat:ButtonMenuItem),
dat:onClick (type xs:string),
dat:originalText (in dat:item in dat:buttonBarOptions),
dat:target (in dat:item in dat:buttonBarOptions)
All Direct / Indirect Based Elements (1):
dat:item (in dat:buttonBarOptions)
Known Usage Locations
Annotation
Supported for SQL metadata
XML Source (see within schema source)
<xs:complexType name="ButtonBarItem">
<xs:annotation>
<xs:documentation>Supported for SQL metadata</xs:documentation>
</xs:annotation>
<xs:choice>
<xs:element maxOccurs="1" minOccurs="1" name="target" type="dat:TargetType">
<xs:annotation>
<xs:documentation>URL to hit when the user selects the item.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="1" minOccurs="1" name="onClick" type="xs:string">
<xs:annotation>
<xs:documentation>
onClick JavaScript handler to be invoked when the user selects the item. This code will be wrapped
in an anonymous function, and will have two variables in scope: dataRegionName, a string with the
name of the DataRegion attached to this grid; dataRegion, a LABKEY.DataRegion object for the
DataRegion attached to this grid.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="1" name="item" type="dat:ButtonMenuItem">
<xs:annotation>
<xs:documentation>Cascading submenu items to attach to the button.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="1" minOccurs="1" name="originalText" type="xs:string">
<xs:annotation>
<xs:documentation>
If specified, the name of the default button to be renamed and added to the button bar. Its
behavior will be unaffected.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
<xs:attribute name="permission" type="dat:PermissionType">
<xs:annotation>
<xs:documentation>
If specified, a permission that the current user must have to view this button.
If not specified, permissionClass is used.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="permissionClass" type="xs:string">
<xs:annotation>
<xs:documentation>
If specified and the "permission" attribute is not specified, the fully qualified Java class name
of the permission that the current user must have to view this button.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="text" type="xs:string">
<xs:annotation>
<xs:documentation>Name of the button to be shown in the UI.</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="iconCls" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>
A font awesome (http://fontawesome.io/) CSS class to apply to this item.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="hidden" type="xs:boolean">
<xs:annotation>
<xs:documentation>
If true, don't include the button in the bar. Useful for hiding selected built-in buttons.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="requiresSelection" type="xs:boolean">
<xs:annotation>
<xs:documentation>
Whether this item should only be enabled if there are no records selected in the grid. Defaults to false.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="requiresSelectionMinCount" type="xs:int">
<xs:annotation>
<xs:documentation>
The minimum number of selections required to be made for this item to be enabled.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="requiresSelectionMaxCount" type="xs:int">
<xs:annotation>
<xs:documentation>
The maximum number of selections required to be made for this item to be enabled.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="insertPosition">
<xs:annotation>
<xs:documentation>
If specified, add this button at the position index or at the beginning or back of the button bar. Not compatible with insertBefore or insertAfter attributes.
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:union memberTypes="xs:int">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="beginning"/>
<xs:enumeration value="end"/>
</xs:restriction>
</xs:simpleType>
</xs:union>
</xs:simpleType>
</xs:attribute>
<xs:attribute name="insertBefore" type="xs:string">
<xs:annotation>
<xs:documentation>
If specified, add this button before the button named by this attribute. Not compatible with insertAfter or insertPosition attributes.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="insertAfter" type="xs:string">
<xs:annotation>
<xs:documentation>
If specified, add this button after the button named by this attribute. Not compatible with insertBefore or insertPosition attributes.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="suppressWarning" type="xs:boolean">
<xs:annotation>
<xs:documentation>
If true, suppress the warning message when originalText references to buttons that don't exist.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
Attribute Detail
hidden
Type:
xs:boolean, predefined
Use:
optional
Defined:
locally, within (this) dat:ButtonBarItem complexType
If true, don't include the button in the bar. Useful for hiding selected built-in buttons.
XML Source (see within schema source)
<xs:attribute name="hidden" type="xs:boolean">
<xs:annotation>
<xs:documentation>
If true, don't include the button in the bar. Useful for hiding selected built-in buttons.
</xs:documentation>
</xs:annotation>
</xs:attribute>
iconCls
Type:
xs:string, predefined
Use:
optional
Defined:
locally, within (this) dat:ButtonBarItem complexType
A font awesome (http://fontawesome.io/) CSS class to apply to this item.
XML Source (see within schema source)
<xs:attribute name="iconCls" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>
A font awesome (http://fontawesome.io/) CSS class to apply to this item.
</xs:documentation>
</xs:annotation>
</xs:attribute>
insertAfter
Type:
xs:string, predefined
Use:
optional
Defined:
locally, within (this) dat:ButtonBarItem complexType
If specified, add this button after the button named by this attribute. Not compatible with insertBefore or insertPosition attributes.
XML Source (see within schema source)
<xs:attribute name="insertAfter" type="xs:string">
<xs:annotation>
<xs:documentation>
If specified, add this button after the button named by this attribute. Not compatible with insertBefore or insertPosition attributes.
</xs:documentation>
</xs:annotation>
</xs:attribute>
insertBefore
Type:
xs:string, predefined
Use:
optional
Defined:
locally, within (this) dat:ButtonBarItem complexType
If specified, add this button before the button named by this attribute. Not compatible with insertAfter or insertPosition attributes.
XML Source (see within schema source)
<xs:attribute name="insertBefore" type="xs:string">
<xs:annotation>
<xs:documentation>
If specified, add this button before the button named by this attribute. Not compatible with insertAfter or insertPosition attributes.
</xs:documentation>
</xs:annotation>
</xs:attribute>
insertPosition
Type:
anonymous (union of (xs:int | restriction of xs:token))
Use:
optional
Defined:
locally, within (this) dat:ButtonBarItem complexType
If specified, add this button at the position index or at the beginning or back of the button bar. Not compatible with insertBefore or insertAfter attributes.
XML Source (see within schema source)
<xs:attribute name="insertPosition">
<xs:annotation>
<xs:documentation>
If specified, add this button at the position index or at the beginning or back of the button bar. Not compatible with insertBefore or insertAfter attributes.
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:union memberTypes="xs:int">
<xs:simpleType>
<xs:restriction base="xs:token">
<xs:enumeration value="beginning"/>
<xs:enumeration value="end"/>
</xs:restriction>
</xs:simpleType>
</xs:union>
</xs:simpleType>
</xs:attribute>
permission
Type:
dat:PermissionType
Use:
optional
Defined:
locally, within (this) dat:ButtonBarItem complexType
If specified, a permission that the current user must have to view this button. If not specified, permissionClass is used.
XML Source (see within schema source)
<xs:attribute name="permission" type="dat:PermissionType">
<xs:annotation>
<xs:documentation>
If specified, a permission that the current user must have to view this button.
If not specified, permissionClass is used.
</xs:documentation>
</xs:annotation>
</xs:attribute>
permissionClass
Type:
xs:string, predefined
Use:
optional
Defined:
locally, within (this) dat:ButtonBarItem complexType
If specified and the "permission" attribute is not specified, the fully qualified Java class name of the permission that the current user must have to view this button.
XML Source (see within schema source)
<xs:attribute name="permissionClass" type="xs:string">
<xs:annotation>
<xs:documentation>
If specified and the "permission" attribute is not specified, the fully qualified Java class name
of the permission that the current user must have to view this button.
</xs:documentation>
</xs:annotation>
</xs:attribute>
requiresSelection
Type:
xs:boolean, predefined
Use:
optional
Defined:
locally, within (this) dat:ButtonBarItem complexType
Whether this item should only be enabled if there are no records selected in the grid. Defaults to false.
XML Source (see within schema source)
<xs:attribute name="requiresSelection" type="xs:boolean">
<xs:annotation>
<xs:documentation>
Whether this item should only be enabled if there are no records selected in the grid. Defaults to false.
</xs:documentation>
</xs:annotation>
</xs:attribute>
requiresSelectionMaxCount
Type:
xs:int, predefined
Use:
optional
Defined:
locally, within (this) dat:ButtonBarItem complexType
The maximum number of selections required to be made for this item to be enabled.
XML Source (see within schema source)
<xs:attribute name="requiresSelectionMaxCount" type="xs:int">
<xs:annotation>
<xs:documentation>
The maximum number of selections required to be made for this item to be enabled.
</xs:documentation>
</xs:annotation>
</xs:attribute>
requiresSelectionMinCount
Type:
xs:int, predefined
Use:
optional
Defined:
locally, within (this) dat:ButtonBarItem complexType
The minimum number of selections required to be made for this item to be enabled.
XML Source (see within schema source)
<xs:attribute name="requiresSelectionMinCount" type="xs:int">
<xs:annotation>
<xs:documentation>
The minimum number of selections required to be made for this item to be enabled.
</xs:documentation>
</xs:annotation>
</xs:attribute>
suppressWarning
Type:
xs:boolean, predefined
Use:
optional
Defined:
locally, within (this) dat:ButtonBarItem complexType
If true, suppress the warning message when originalText references to buttons that don't exist.
XML Source (see within schema source)
<xs:attribute name="suppressWarning" type="xs:boolean">
<xs:annotation>
<xs:documentation>
If true, suppress the warning message when originalText references to buttons that don't exist.
</xs:documentation>
</xs:annotation>
</xs:attribute>
text
Type:
xs:string, predefined
Use:
optional
Defined:
locally, within (this) dat:ButtonBarItem complexType
Name of the button to be shown in the UI.
XML Source (see within schema source)
<xs:attribute name="text" type="xs:string">
<xs:annotation>
<xs:documentation>Name of the button to be shown in the UI.</xs:documentation>
</xs:annotation>
</xs:attribute>
Content Element Detail
dat:item
Type:
dat:ButtonMenuItem, complex content
Defined:
locally, within (this) dat:ButtonBarItem complexType
Cascading submenu items to attach to the button.
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="1" name="item" type="dat:ButtonMenuItem">
<xs:annotation>
<xs:documentation>Cascading submenu items to attach to the button.</xs:documentation>
</xs:annotation>
</xs:element>
dat:onClick
Type:
xs:string, predefined, simple content
Defined:
locally, within (this) dat:ButtonBarItem complexType
onClick JavaScript handler to be invoked when the user selects the item. This code will be wrapped in an anonymous function, and will have two variables in scope: dataRegionName, a string with the name of the DataRegion attached to this grid; dataRegion, a LABKEY.DataRegion object for the DataRegion attached to this grid.
XML Source (see within schema source)
<xs:element maxOccurs="1" minOccurs="1" name="onClick" type="xs:string">
<xs:annotation>
<xs:documentation>
onClick JavaScript handler to be invoked when the user selects the item. This code will be wrapped
in an anonymous function, and will have two variables in scope: dataRegionName, a string with the
name of the DataRegion attached to this grid; dataRegion, a LABKEY.DataRegion object for the
DataRegion attached to this grid.
</xs:documentation>
</xs:annotation>
</xs:element>
dat:originalText
Type:
xs:string, predefined, simple content
Defined:
locally, within (this) dat:ButtonBarItem complexType
If specified, the name of the default button to be renamed and added to the button bar. Its behavior will be unaffected.
XML Source (see within schema source)
<xs:element maxOccurs="1" minOccurs="1" name="originalText" type="xs:string">
<xs:annotation>
<xs:documentation>
If specified, the name of the default button to be renamed and added to the button bar. Its
behavior will be unaffected.
</xs:documentation>
</xs:annotation>
</xs:element>
dat:target
Type:
dat:TargetType, simple content
Defined:
locally, within (this) dat:ButtonBarItem complexType
URL to hit when the user selects the item.
XML Source (see within schema source)
<xs:element maxOccurs="1" minOccurs="1" name="target" type="dat:TargetType">
<xs:annotation>
<xs:documentation>URL to hit when the user selects the item.</xs:documentation>
</xs:annotation>
</xs:element>
This XML schema documentation has been generated with DocFlex/XML RE 1.7.2 using DocFlex/XML XSDDoc 2.1.0 template set.
DocFlex/XML RE is a reduced edition of DocFlex/XML, which is a tool for programming and running highly sophisticated documentation and reports generators by the data obtained from any kind of XML files. The actual doc-generators are implemented in the form of special templates that are designed visually using a high quality Template Designer GUI basing on the XML schema (or DTD) files describing the data source XML.
DocFlex/XML XSDDoc is a commercial template application of DocFlex/XML that implements a high-end XML Schema documentation generator with simultaneous support of framed multi-file HTML, single-file HTML and RTF output formats. (More formats are planned in the future).
A commercial license for "DocFlex/XML XSDDoc" will allow you:
  • To configure the generated documentation so much as you want. Thanks to our template technology, it was possible to support more than 300 template parameters (working the same as "options" of an ordinary doc-gen), which will give you an unprecedented control over the generated content!
  • To use certain features disabled in the free mode (such as the full documenting of substitution groups).
  • To enable/disable documenting of the initial, imported, included and redefined XML schemas selectively.
  • To document local element components both globally and locally (similar to attributes).
  • To enable/disable reproducing of namespace prefixes.
  • To format your annotations with XHTML tags and reproduce that formatting both in HTML and RTF output.
  • To insert images in your annotations using XHTML <img> tags (supported both in HTML and RTF output).
  • To use PlainDoc.tpl main template to generate all the XML schema documentation in the form of a single HTML file.
  • To use the same template to generate the incredible quality RTF documentation.
  • To document only selected XML schema components specified by name.
  • To remove this very advertisement text
Once having only such a license, you will be able to run the fully-featured XML schema documentation generator both with DocFlex/XML SDK and with DocFlex/XML RE, which is a reduced free edition containing only the template interpretor / output generator. No other licenses will be required!
But this is not all. In addition to it, a commercial license for DocFlex/XML SDK will allow you to modify the XSDDoc templates themselves as much as you want. You will be able to achieve whatever was impossible to do with the template parameters only. And, of course, you could develop any template applications by your own!
Please note: By purchasing a license for this software, you not only acquire a useful tool, you will also make an important investment in its future development, the result of which you could enjoy later by yourself. Every single your purchase matters and makes a difference for us!
To buy a license, please follow this link: http://www.filigris.com/shop/