Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
STP/Policy Component/XEF Reference
XEF Reference
Contents
The way the XEF editor renders widgets is based on the XML Schema definition of the elements and attributes. It can be influenced by putting addition information in the schema, or by providing annotations. The annotations are divided over two namespaces, xef (http://schemas.eclipse.org/stp/xsd/2006/05/xef) and xefgui (http://schemas.eclipse.org/stp/xsd/2006/05/xef/gui). The xef namespace contains information that is not purely GUI-related (e.g. it could also be used for non-gui purposes such as generating extra documentation around an element). The xefgui namespace contains purely widget-related information.
The xef and xefgui namespaces are documented in their own XML-Schema files that can be found in the following locations: [xef] [xefgui]
Below you can find a list of the various ways in which the XEF editor can be influenced.
Basics
Category
| Annotation | <xef:category> - String |
|---|---|
| Description | Provides categorization for the element or attribute. For elements the category is used in the Schema Selection Dialog, for attributes the category is used to put the attribute in a collapsible section in the editor. |
| Applies to | <xs:element> and <xs:attribute> |
| Before |
attributes:
elements: |
| After |
attributes:
elements: |
| Example |
<xs:element name="audit">
<xs:annotation>
<xs:appinfo>
<xef:category>Logging</xef:category>
</xs:appinfo>
</xs:annotation>
</xs:element>
|
Display Name
| Annotation | <xef:displayName> - String |
|---|---|
| Description | Provides a human readable name for the attribute or element. |
| Applies to | <xs:element> and <xs:attribute> |
| Before |
attributes:
elements: |
| After |
attributes:
elements: |
| Example |
<xs:attribute name="every_client" type="xs:boolean">
<xs:annotation>
<xs:appinfo>
<xef:displayName>Every Client</xef:displayName>
</xs:appinfo>
</xs:annotation>
</xs:attribute>
|
Read-Only Widgets
Getting a field displayed using read-only widgets is possible in two ways:
- using the
fixed="..."attribute in the XML Schema definition. This doesn't allow the value to be changed at all. - There is an alternative for when it's desirable that the editor doesn't change it. The use of
<xefgui:widget>read_only</xefgui:widget>simple draws a readonly widget.
Fixing the value in the Schema
| Annotation | <xs:element ... fixed="my fixed value"> |
|---|---|
| Description | Fixes the value of an attribute or element in the schema. |
| Applies to | <xs:element> and <xs:attribute> |
| Before | 
|
| After | 
|
| Example |
<xs:attribute name="output" type="xs:string" fixed="System Console" /> |
Marking the widget as Read-Only
| Annotation | <xefgui:widget>read_only</xefgui:widget> |
|---|---|
| Description | Creates read-only widgets in the editor. |
| Applies to | <xs:element> and <xs:attribute> |
| Before |
|
| After |
|
| Example |
<xs:attribute name="output" type="xs:string" >
<xs:annotation>
<xs:appinfo>
<xefgui:widget>read_only</xefgui:widget>
</xs:appinfo>
</xs:annotation>
</xs:attribute>
|
Tool Tips
| Annotation | <xef:docShort> - String |
|---|---|
| Description | Provides tooltips on the controls that display the elements and attributes. |
| Applies to | <xs:element> and <xs:attribute> |
| Before | 
|
| After | 
|
| Example |
<xs:attribute name="sample_interval" type="xs:positiveInteger">
<xs:annotation>
<xs:appinfo>
<xef:docShort>Defines how often the log is sampled for auditing</xef:docShort>
</xs:appinfo>
</xs:annotation>
</xs:attribute>
|
Units
| Annotation | <xef:units> - String |
|---|---|
| Description | Places an extra label to describe the units of measurement for the attribute in the editor. |
| Applies to | <xs:attribute> |
| Before | 
|
| After | 
|
| Example |
<xs:attribute name="sample_interval" type="xs:int" default="5000">
<xs:annotation>
<xs:appinfo>
<xef:units>ms</xef:units>
</xs:appinfo>
</xs:annotation>
</xs:attribute>
|