org.xngr
Interface DirectoryMarker

All Superinterfaces:
Marker

public interface DirectoryMarker
extends Marker

Identifies and presents a 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
 java.lang.String getDirectoryName()
          Return the directory name, this name is used to 'quickly' identify directories which can be used as input for this service, this method is not allowed to return null.
 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.
 
Methods inherited from interface org.xngr.Marker
getIdentifier
 

Method Detail

getDirectoryName

java.lang.String getDirectoryName()
Return the directory name, this name is used to 'quickly' identify directories which can be used as input for this service, this method is not allowed to return null.

Returns:
the name used to identify directories.

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.


Copyright © 2002-2009 Edwin Dankert. All Rights Reserved.