public interface IConfigurationElement
IConfigurationElement
interface.
A configuration element, with its attributes and children,
directly reflects the content and structure of the extension section
within the declaring plug-in's manifest (plugin.xml
) file.
This interface also provides a way to create executable extension objects.
This interface is not intended to be implemented by clients.
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
createExecutableExtension(java.lang.String propertyName)
Creates and returns a new instance of the executable extension
identified by the named attribute of this configuration element.
|
java.lang.String |
getAttribute(java.lang.String name)
Returns the named attribute of this configuration element, or
null if none. |
java.lang.String |
getAttributeAsIs(java.lang.String name)
Returns the named attribute of this configuration element, or
null if none. |
java.lang.String[] |
getAttributeNames()
Returns the names of the attributes of this configuration element.
|
IConfigurationElement[] |
getChildren()
Returns all configuration elements that are children of this
configuration element.
|
IConfigurationElement[] |
getChildren(java.lang.String name)
Returns all child configuration elements with the given name.
|
IExtension |
getDeclaringExtension()
Returns the extension that declares this configuration element.
|
java.lang.String |
getName()
Returns the name of this configuration element.
|
java.lang.Object |
getParent()
Returns the element which contains this element.
|
java.lang.String |
getValue()
Returns the text value of this configuration element.
|
java.lang.String |
getValueAsIs()
Returns the untranslated text value of this configuration element.
|
java.lang.Object createExecutableExtension(java.lang.String propertyName) throws FrameworkException
The specified class is instantiated using its 0-argument public
constructor. If the specified class implements the
IExecutableExtension
interface, the method
setInitializationData
is called, passing to the object
the configuration information that was used to create it.
Unlike other methods on this object, invoking this method may activate the plug-in.
propertyName
- the name of the propertyFrameworkException
- if an instance of the executable extension
could not be created for any reason.IExecutableExtension.setInitializationData(IConfigurationElement, String, Object)
java.lang.String getAttribute(java.lang.String name)
null
if none.
The names of configuration element attributes are the same as the attribute names of the corresponding XML element. For example, the configuration markup
<bg pattern="stripes"/>corresponds to a configuration element named
"bg"
with an attribute named "pattern"
with attribute value "stripes"
.
Note that any translation specified in the plug-in manifest file is automatically applied.
name
- the name of the attributenull
if nonejava.lang.String getAttributeAsIs(java.lang.String name)
null
if none.
The names of configuration element attributes are the same as the attribute names of the corresponding XML element. For example, the configuration markup
<bg pattern="stripes"/>corresponds to a configuration element named
"bg"
with an attribute named "pattern"
with attribute value "stripes"
.
Note that any translation specified in the plug-in manifest file for this attribute is not automatically applied.
name
- the name of the attributenull
if nonejava.lang.String[] getAttributeNames()
The names of configuration element attributes are the same as the attribute names of the corresponding XML element. For example, the configuration markup
<bg color="blue" pattern="stripes"/>corresponds to a configuration element named
"bg"
with attributes named "color"
and "pattern"
.
IConfigurationElement[] getChildren()
Each child corresponds to a nested XML element in the configuration markup. For example, the configuration markup
<view>     <verticalHint>top</verticalHint>     <horizontalHint>left</horizontalHint> </view>corresponds to a configuration element, named
"view"
,
with two children.
getChildren(String)
IConfigurationElement[] getChildren(java.lang.String name)
name
- the name of the child configuration elementgetChildren()
IExtension getDeclaringExtension()
java.lang.String getName()
<wizard name="Create Project"/>corresponds to a configuration element named
"wizard"
.java.lang.Object getParent()
IExtension
.
Otherwise the returned value can be downcast to
IConfigurationElement
.null
java.lang.String getValue()
<script lang="javascript">.\scripts\cp.js</script>corresponds to a configuration element
"script"
with value ".\scripts\cp.js"
.
Values may span multiple lines (i.e., contain carriage returns and/or line feeds).
Note that any translation specified in the plug-in manifest file is automatically applied.
null
java.lang.String getValueAsIs()
<script lang="javascript">.\scripts\cp.js</script>corresponds to a configuration element
"script"
with value ".\scripts\cp.js"
.
Values may span multiple lines (i.e., contain carriage returns and/or line feeds).
Note that translation specified in the plug-in manifest file is not automatically applied. For example, the configuration markup
<tooltip>#hattip</tooltip>corresponds to a configuration element, named
"tooltip"
,
with value "#hattip"
.
null
Copyright © 2014 OpenText Corp. All rights reserved.