com.borland.jbuilder.node
Class IDLFileNode

java.lang.Object
  |
  +--com.borland.primetime.node.Node
        |
        +--com.borland.primetime.node.UrlNode
              |
              +--com.borland.primetime.node.FileNode
                    |
                    +--com.borland.primetime.node.TextFileNode
                          |
                          +--com.borland.jbuilder.node.IDLFileNode
All Implemented Interfaces:
java.lang.Comparable

public class IDLFileNode
extends TextFileNode

IDLFileNode instances represent CORBA Interface Definition Language files.


Field Summary
static java.lang.String EXTENSION
          The default extension of files represented by this class.
static javax.swing.Icon ICON
          The icon used for files for this class.
static java.lang.String PAGE_NAME
          The name used by the PropertyPage for IDL files.
 
Fields inherited from class com.borland.primetime.node.Node
EMPTY_ARRAY, nodeListeners
 
Constructor Summary
IDLFileNode(Project project, Node parent, Url url)
          All FileNode subtypes must expose this constructor signature.
 
Method Summary
 void addIDL2PackageMapping(java.lang.String module, java.lang.String pkg)
          This routine updates the idl2package mapping.
 com.borland.jbuilder.cot.CotSourceFile getCotSourceFile()
          This routine constructs/returns the source manager for a given instance of an IDL file for use by COT.
 Node[] getDisplayChildren()
          This routine returns the children of this node which were generated by idl2java.
 javax.swing.Icon getDisplayIcon()
          Return the icon used for this type of file.
 java.lang.Class getEditorKitClass()
          Get the IDLCorbaEditorKit class used by this file node type to customize the editor.
 java.lang.String[][] getIDL2PackageMapping()
          This routine finds all idl2package mappings for this IDL file.
 java.lang.Class getTextStructureClass()
          Get the type of the IDLStructure class that is responsible for managing the structure pane for this file node type.
static void initOpenTool(byte majorVersion, byte minorVersion)
          OpenTool initialization
 void removeIDL2PackageMapping(java.lang.String module)
          This routine removes the idl2package mapping.
 
Methods inherited from class com.borland.primetime.node.TextFileNode
getEncoding, setCaretPosition
 
Methods inherited from class com.borland.primetime.node.FileNode
check, findBuffer, findFileNodeClass, findFileNodeClass, findFileNodeClass, getBuffer, getDisplayName, getDisplaySequence, getInputStream, getLongDisplayName, getOutputStream, getTimestamp, getUrl, isModified, isNew, isPersistant, isReadOnly, registerFileNodeClass, rename, revert, save, saveAs, setUrl
 
Methods inherited from class com.borland.primetime.node.UrlNode
getSuggestedUrl
 
Methods inherited from class com.borland.primetime.node.Node
addNodeListener, compareTo, dumpNodes, dumpNodes, dumpNodes, equals, fireNodeRenamed, getChildren, getNodeID, getParent, getProject, getProperties, getProperty, getProperty, getProperty, hasChildren, hasDisplayChildren, hashCode, makePersistant, removeNodeListener, setParent, setProperty, setProperty, setProperty, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

EXTENSION

public static final java.lang.String EXTENSION
The default extension of files represented by this class.

PAGE_NAME

public static final java.lang.String PAGE_NAME
The name used by the PropertyPage for IDL files.

ICON

public static final javax.swing.Icon ICON
The icon used for files for this class.
Constructor Detail

IDLFileNode

public IDLFileNode(Project project,
                   Node parent,
                   Url url)
            throws DuplicateNodeException
All FileNode subtypes must expose this constructor signature.
Parameters:
project - Project (cannot be null) to which this node will be associated.
parent - Immediate parent (may be null) of this node and must be of same Project.
url - The storage available to this node.
Throws:
DuplicateNodeException - if node already registered.
See Also:
Project.getNode(com.borland.primetime.vfs.Url)
Method Detail

initOpenTool

public static void initOpenTool(byte majorVersion,
                                byte minorVersion)
OpenTool initialization
Parameters:
majorVersion - Major release number for which OpenTool is being initialized.
minorVersion - Minor release number for which OpenTool is being initialized.

getCotSourceFile

public com.borland.jbuilder.cot.CotSourceFile getCotSourceFile()
This routine constructs/returns the source manager for a given instance of an IDL file for use by COT.
Returns:
Returns the manager class for usage by COT.

addIDL2PackageMapping

public void addIDL2PackageMapping(java.lang.String module,
                                  java.lang.String pkg)
This routine updates the idl2package mapping.
Parameters:
module - Module name.
pkg - PackageName.

removeIDL2PackageMapping

public void removeIDL2PackageMapping(java.lang.String module)
This routine removes the idl2package mapping.
Parameters:
module - Module name.

getIDL2PackageMapping

public java.lang.String[][] getIDL2PackageMapping()
This routine finds all idl2package mappings for this IDL file.
Returns:
Returns all idl2package mappings.

getTextStructureClass

public java.lang.Class getTextStructureClass()
Get the type of the IDLStructure class that is responsible for managing the structure pane for this file node type.
Overrides:
getTextStructureClass in class TextFileNode
Returns:
Returns appropriate structure pane manager for this file type.

getEditorKitClass

public java.lang.Class getEditorKitClass()
Get the IDLCorbaEditorKit class used by this file node type to customize the editor.
Overrides:
getEditorKitClass in class TextFileNode
Returns:
The editor kit to use.

getDisplayIcon

public javax.swing.Icon getDisplayIcon()
Return the icon used for this type of file.
Overrides:
getDisplayIcon in class TextFileNode
Returns:
The icon for this file type.

getDisplayChildren

public Node[] getDisplayChildren()
This routine returns the children of this node which were generated by idl2java. return Returns array of Nodes generated by idl2java.
Overrides:
getDisplayChildren in class Node
Following copied from class: com.borland.primetime.node.Node
Returns:
An array of Node instances, or an empty array if no such nodes exist.