org.xngr
Interface DocumentMarker

All Superinterfaces:

Marker

public interface DocumentMarker
extends Marker

Identifies and presents a XML document in the system.

Version:

$Revision: 51 $, $Date: 2009-03-24 22:37:03 +0000 (Tue, 24 Mar 2009) $

Author:

Edwin Dankert

Method Summary

java.lang.String	getDescription(java.net.URI uri) The description is normally used to provide more information for the object or the nature of the object, this information is generally not readily available but will appear after a user-action, like moving the mouse over a representation of the object, for instance as a tool-tip
javax.swing.Icon	getIcon(java.net.URI uri) The icon is normally used to identify the object type and state.
java.lang.String	getName(java.net.URI uri) The name is normally used to (uniquely) identify the object in a view.
javax.xml.namespace.QName	getRootElementName() Return the document root element name, this is used to quickly identify XML documents, this method is not allowed to return null.

Methods inherited from interface org.xngr.Marker

getIdentifier

Method Detail

getRootElementName

javax.xml.namespace.QName getRootElementName()

Return the document root element name, this is used to quickly identify XML documents, this method is not allowed to return null. Note: only the namespace-URI and local name of the QName are used for comparison, the prefix is always ignored.

Returns:

the document root element name.

getIcon

javax.swing.Icon getIcon(java.net.URI uri)

The icon is normally used to identify the object type and state.

Parameters:

object - the object to return the icon for. Note: the provided object should not be modified.

Returns:

the icon for the object.

getName

java.lang.String getName(java.net.URI uri)

The name is normally used to (uniquely) identify the object in a view.

Parameters:

object - the object to return the name for. Note: the provided object should not be modified.

Returns:

the name for the object.

getDescription

java.lang.String getDescription(java.net.URI uri)

The description is normally used to provide more information for the object or the nature of the object, this information is generally not readily available but will appear after a user-action, like moving the mouse over a representation of the object, for instance as a tool-tip

Parameters:

object - the object to return the description for. Note: the provided object should not be modified.

Returns:

the description for the object.