DocumentSvc Class

com.bea.ide.document
DocumentSvc Class

public class DocumentSvc

    extends Object

The document service is the primary way that extensions in the Workshop IDE obtain and display document objects. A document in the IDE is an abstract interface over a file. The implementation of the document interface is dependent on the type of the file. Files are mapped to document handlers to determine their type. The document service is responsible for mapping a file to a document handler. It then invokes the document handler to create the document from the file. Document handlers are registered using extension XML.

The extension XML for document handlers is as follows:

  <document-handler class="{class}"
      label="{label}" [icon="{image-resource}"]>
      <file-extension [priority="{priority}]">{extension}</file-extension>*
      <project-attributes><attribute name="{attr-name}" value="{attr-value}"/>*</project-attributes>*
      <create-template id="{id}" label="{label}" priority="{priority}" [createCategories="{categories}"]
          [wizard="true" [hideFilePath="true"]]>
        [<description>{description}<description>]
      </create-template>*
   </document-handler>
 

Items in [] are optional.
Items followed by * indicate 0 or more may be present
Items in {} are values as defined below:

For more information on fluency see IDocumentHandler.Priority.
For more information on templates see IDocumentInfo.ITemplate.
For more information on project-attributes see IDocumentHandler.


Hierarchy
Object
  DocumentSvc

Nested Class Summary

public static interfaceDocumentSvc.I

Field Summary

protected static DocumentSvc.I
instance
DocumentSvc.I
 

Constructor Summary

DocumentSvc()

 

Method Summary

public static DocumentSvc.I
get()
Returns the global static instance of the interface to this service.
 
Methods from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
   

Field Detail

instance

protected static DocumentSvc.I instance

 

Constructor Detail

DocumentSvc

public DocumentSvc()
 

Method Detail

get() Method

public static DocumentSvc.I get()
Returns the global static instance of the interface to this service.

Returns

Instance object implementing the DocumentSvc.I interface