com.borland.jbuilder.node
Class XMLFileNode

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.XMLFileNode
All Implemented Interfaces:
java.lang.Comparable
Direct Known Subclasses:
TldFileNode

public class XMLFileNode
extends TextFileNode

XMLFileNode instances represent XML files and files with XML derived languages, such as XSL and WML.


Field Summary
static java.lang.String EXTENSION
          The default extension of XML files.
static java.lang.String EXTENSION_WML
          The default extension of WML files.
static java.lang.String EXTENSION_XSL
          The default extension of XSL files.
static javax.swing.Icon ICON
          The icon used for files for this class.
 
Fields inherited from class com.borland.primetime.node.Node
EMPTY_ARRAY, nodeListeners
 
Constructor Summary
XMLFileNode(Project project, Node parent, Url url)
          All FileNode subtypes must expose this constructor signature.
 
Method Summary
 javax.swing.Icon getDisplayIcon()
          Return the icon used for this type of file.
 java.lang.Class getEditorKitClass()
          Get the XMLEditorKit class used by this file node type to customize the editor.
 java.lang.String getEncoding()
          Override the default behavior of using the project file encoding since XML files tend to mark their encoding in the header.
 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
 
Methods inherited from class com.borland.primetime.node.TextFileNode
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, getDisplayChildren, 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 XML files.

ICON

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

EXTENSION_XSL

public static final java.lang.String EXTENSION_XSL
The default extension of XSL files.

EXTENSION_WML

public static final java.lang.String EXTENSION_WML
The default extension of WML files.
Constructor Detail

XMLFileNode

public XMLFileNode(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.
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.

getEditorKitClass

public java.lang.Class getEditorKitClass()
Get the XMLEditorKit 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.

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.

getEncoding

public java.lang.String getEncoding()
Override the default behavior of using the project file encoding since XML files tend to mark their encoding in the header. Here is a link to read up on this stuff: http://www.w3.org/TR/1998/REC-xml-19980210
Overrides:
getEncoding in class TextFileNode
Returns:
The encoding as determined from opening the file and looking at the Byte Order Mark and the xml header.