This interface is used by the IDE's property view to
display the properties of the currently selected IElement.
See IDocumentView
for how to set
a driver on a view, and how to set the view's selected
IElement
.
The property heirarchy of an IElement is exposed through the getProperties method. Properties may be organized into multiple levels of grouping. However, note that the top level of the heirarchy is expected to be a list of one or more property groups. Thus nodes at the top level of the heirarchy may not display a value in the property view. After the first level, any node in the heirarchy may have a value, be a container of nested properties, or both.
Additionally, this interface provides instance label, type label, and description information for the IElement itself. The instance label and type label of the Element is displayed in the title bar of the property view. When the title bar is selected, the element's description will appear in the property view description window.
Related Topics
IDocumentView
IElement
IPropertyNode
IProperty
DefaultPropertyViewDriver
Nested Class Summary |
public static interface | IPropertyViewDriver.IPropertyViewContext
Interface to provide access to the view context of the property view. |
Field Summary |
public static final |
|
public static final |
|
Method Summary |
public |
|
public |
|
public |
|
public |
|
public | |
public |
|
public |
|
public void |
|
Field Detail |
public static final List
NO_REFRESH_LIST
public static final String
NO_REFRESH_STRING
Method Detail |
publicDescription of this type of element.String
getDescription(IElement
el)
publicAllows the property view driver to display properties for a different element than that which was selected in the document.IElement
getDisplayElement(IElement
activeElement)
publicReturns an array of URIs containing help context identifiers for context-sensitive help. A help context URI is a URN where the namespace identifies the type of thing selected (e.g. javadoc-tag) and the scheme-specific part identifies which item is selected. In the case of the PropertyView, a typical selection would be a "property" that represents a Javadoc tag from a JWS or JCX file. An example of the URN for the @common:operation is urn:javadoc-tag:common/operation.URI
[] getHelpContextList(IElement
el)
Related Topics
publicReturns an array of URIs containing help context identifiers for context-sensitive help. A help context URI is a URN where the namespace identifies the type of thing selected (e.g. javadoc-tag) and the scheme-specific part identifies which item is selected. In the case of the PropertyView, a typical selection would be a "property" that represents a Javadoc tag from a JWS or JCX file. An example of the URN for the @common:operation is urn:javadoc-tag:common/operation.URI
[] getHelpContextList(IPropertyNode
node)
Related Topics
publicDisplay name identifying this element instance. Note that this label should be different than the string returned by getTypeLabel().String
getLabel(IElement
el)
Elements of the same type would have have the same type label, but different instance labels.
publicReturns a list of IPropertyNodes. This list is the top level of the property heirarchy displayed in the property view. The property view expects that all top level nodes represent property groups and will not not display values for these nodes. After the top-level, nodes implementing IProperty will display a value.List
getProperties(IElement
el)
If this element has no displayable properties, an empty List should be returned. Use of Collections.EMPTY_LIST is recommended.
publicDisplay name identifying this type of element.String
getTypeLabel(IElement
el)
Elements of the same type would have have the same type label, but different instance labels.
public void setContext(IPropertyViewDriver.IPropertyViewContext
context)
Sets the view context for this driver. Usually set by the
view but can be used by drivers which wrap or extend other
drivers.