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.
Difference between revisions of "STP/Policy Component/XEF Reference"
(→Using the fixed XML Schema Attribute) |
(→Read-Only Widgets) |
||
Line 101: | Line 101: | ||
=== Read-Only Widgets === | === Read-Only Widgets === | ||
− | + | Getting a field displayed using read-only widgets is possible in two ways: | |
− | There is an alternative for when it's desirable that the '''editor''' doesn't change it. The use of <code><xefgui:widget>read_only</xefgui:widget></code> simple draws a readonly widget. | + | 1. using the <code>fixed="..."</code> attribute in the XML Schema definition. This doesn't allow the value to be changed at all. |
+ | 2. There is an alternative for when it's desirable that the '''editor''' doesn't change it. The use of <code><xefgui:widget>read_only</xefgui:widget></code> simple draws a readonly widget. | ||
==== Fixing the value in the Schema ==== | ==== Fixing the value in the Schema ==== |
Revision as of 12:49, 12 December 2007
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 |
|
After |
|
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 |
|
After |
|
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:
1. using the fixed="..."
attribute in the XML Schema definition. This doesn't allow the value to be changed at all.
2. 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.