JXMLPad 

Features :

• JavaBean usage
• Syntax coloration (tag, string, entities...)
• Syntax completion on DTD,Schema, RelaxNG
• Access to your schema/dtd with the classpath or a custom path
  
• Smart parsing engine (relative location and detection for schema, DTD)
  
• Look-and-feel plugIn with themes
• Customizable action toolbar
• Customizable coloration for tags, attributes,namespaces
  
• Real time syntax error
• Real time tree text synchronization location
• Drag and drop for copying/moving nodes
  
• Template for fast creation
• Easy to integrate in your application
• Several standard action for XML usage (parsing, format, search, comment...)
• Standard Swing EditorKit
• Auto tag closing
• XML integrity for avoiding invalid XML document
  
• Customizable with a property file
• Intertionalization for labels, tooltips ...
  
• Very rich API : Totally customizable
• JXMLAppKit for multiple editors.
  
• Sample for JSP/XML editing, inner frame, applet and standalone usage
  

I. Usage

1. The main container : XMLContainer
2. A default toolbar inside the XMLContainer
3. A default popup inside the XMLContainer
4. A default message location and error panel inside the XMLContainer
   
5. One editor or two editors inside the XMLContainer : XMLEditor
   
6. One tree view always synchronized with the text changes
7. One element view synchronized with the tree selection

a. Fast starting

• Accessibility is a facility for setting/getting a text easily, calling an action... Accessibility is available by calling getAccessibility on the XMLContainer.
• UIAccessibility is a facility for accessing to inner XMLContainer parts like the tree or a splitpane. User can also update the initial  location of a splitpane, hide the tree or the toolbar...
• SchemaAccessibility is a facility for updating the default schema or accessing to the current one....
• DocumentColorAccessibility is a facility for coloring a document part.
  

b. Toolkit usage

c. Simple usage

d. Application usage

e. Applet usage

f. Multiple editor usage

1. Add a listener for resetting the ActionModel to the current XMLContainer. It will notify all XMLAction that they must work on another XMLContainer.
2. On each change event from a tabbedPane selection, reset the Action state calling resetActionState
3. Build the common toolbar calling buildToolBar
4. Disable the default XMLContainer toolbar calling setToolBarAvailable( false )

g. Internal frame usage

public class InternalFrameSample implements WindowListener {

    public void windowActivated(WindowEvent e) {}
    public void windowClosed(WindowEvent e) {}

    public void windowClosing(WindowEvent e) {
	// Freeing all inner resources
	// We stop using editor1 and editor2
	editor1.dispose();
	editor2.dispose();
    }

    public void windowDeactivated(WindowEvent e) {}

    public void windowDeiconified(WindowEvent e) {}

    public void windowIconified(WindowEvent e) {}

    public void windowOpened(WindowEvent e) {}

    public InternalFrameSample() {
	init();
    }

    private XMLContainer editor1;
    private XMLContainer editor2;

    public void init() {
        JFrame frame = new JFrame();
        frame.addWindowListener( this );
        JDesktopPane dp = new JDesktopPane();

        // Add two inner frame

        JInternalFrame editorFrameOne = new JInternalFrame();
        editorFrameOne.setTitle( "My editor 1" );
        // This constructor avoids XMLContainer for freeing automatically its inner reference
        editor1 = new XMLContainer();
        editor1.setText( "<?xml version='1.0'?>\n<test></test>" );
        editorFrameOne.getContentPane().add( editor1.getView() );
        editorFrameOne.setResizable( true );

        dp.add( editorFrameOne );

        editorFrameOne.setSize( 200, 200 );        
        editorFrameOne.setVisible( true );
        editorFrameTwo.setVisible( true );       

        frame.getContentPane().add( dp );
        frame.setSize( 400, 400 );

        frame.setVisible( true );

    }

II. Actions

a. Definition

• Replace existing action by your action
• Enable/Disable action
• Retreive an action by its name
• List available actions
• Run an action by its name
• Reset the Action state for working on a particular XMLContainer or XMLEditor
  

b. Usage

1. Replacing existing default action by your action

2. Disabled/Enabled current action

3. Invoke an action

4. Properties file definition

5. New actions

6. Internationalization

• LABEL : action name for menus
• TOOLTIP=swing tooltip content
  
• MNEMONIC=Mnemonic, ex 'A' for underline A in the LABEL value
  
• ACCELERATOR=Shortcut from the java KeyStroke gramme, ex : 'ctrl A'
• ICON=Icon, ex : com/japisoft/xmlpad/action/edit/CopyAction16.gif
• GROUP=Group name, ex : Edit

7. UIManager for changing the look

c. Default actions

III. Helper

• Element completion (from a schema like DTD, W3C Schema or XML RelaxNG)
  
• Entity completion (from DTD declaration and default ones).
  
• System completion like CDATA or comment. This completion is enabled by inserting "<!".
  

1. By reading a DTD (relative to the current document or not). This DTD can be provided calling the setDefaultDTD or setDTD of the XMLContainer or directly inside the SyntaxHelper. This DTD will be automatically read in your current XMLDocument each time it is saved, loaded or parsed. The DefaultDTD is used if no DTD has been found into the current document.
2. By reading a Schema (relative to the current document or not). This Schema can be provided calling the setDefaultSchema or setSchema from the XMLContainer. This schema will be automatically read in your current XMLDocument each time it is saved, loaded or parsed.
3. By reading a RelaxNG grammar. This grammar is set by calling setRelaxNGValidationLocation on the XMLContainer. Once the grammar (XML form) provided, completion and parsing will use relaxNG but there's a current schema or DTD.
   
4. By using a static document descriptor. This descriptor is not available directly. The user has to call the addTagDescriptor method on the SyntaxHelper.
   

IV. Status bar

V. LookAndFeel

a. The Look interface

GreenTheme.install();
JFrame fr = new JFrame();
XMLContainer container = new XMLContainer();
//We don't want the element view
//container.setElementView( null );
fr.getContentPane().add( container.getView() );
fr.setSize( 300, 300 );
fr.setVisible( true );

For defining or updating a theme, look at the UIManager section for a complete properties listing. Note that the following Look and Feel system will be deprecated. We advise you to use the UIManager for commodity.

b. UIManager

VI. Component properties

VII.  XML integrity

1. Avoiding to corrupt XML tag. So in such mode, user cannot modify current tags but it's always possible to modify other XML parts
2. Checking if a saved document is valid by parsing it. If the document is not valid, the document cannot be saved. 

VIII. Custom Node Editor

IX. Customize the parser

"Different vendors provide different implementations of this abstract class. Java chooses the one to use based on the following conditions in order of preference:

X. Localized the editor messages

XI. Shared a tree

// Here a sub class for the internal frame that contains an XMLContainer
public class DemoInternalFrame2 extends JInternalFrame {

        private XMLContainer container;

	// This is the common tree and we specify the first one having the focus
        public DemoInternalFrame2( JTree sharedTree, boolean focus ) {

                super();
                container = new XMLContainer();

                // This is the initial focus
                if ( focus )                        
			container.focus();

                else
			container.unfocus();

                // We shared this tree

                container.setTreeDelegate( sharedTree );
                getContentPane().add( container );
                // Here a listener for detecting that our container looses the focus
                addInternalFrameListener( new CustomInternalFrameAdapter() );

        }

        // It is important to have only one container having the focus at a time

        class CustomInternalFrameAdapter extends InternalFrameAdapter {

                public void internalFrameClosed( InternalFrameEvent e ) {
                        // We dispose the container
                        container.dispose();
                }

                public void internalFrameActivated( InternalFrameEvent e) {
                        // We unfocus the previous focus container
                        JDesktopPane dp = getDesktopPane();
                        JInternalFrame[] frame = dp.getAllFrames();
                        for ( int i = 0; i < frame.length; i++ ) {
                                if ( frame[ i ] instanceof DemoInternalFrame2 ) {
                                        if ( ( ( DemoInternalFrame2 )frame[ i ] ).container.hasFocus() ) {
                                                ( ( DemoInternalFrame2 )frame[ i ] ).container.unfocus();
                                                break;
                                        }
                                }
                        }

                        // Notify the container that he has the focus
                        container.focus();
                }

        }        

	public static void main( String[] args ) {
 

                JFrame fr = new JFrame();
                final JDesktopPane dp = new JDesktopPane();
                fr.getContentPane().add( dp );

                JInternalFrame treeFrame = new JInternalFrame( "Tree" );
                // We build here the tree shared by several XMLContainer
                final JTree sharedTree = new JTree();
                // We update the "look-and-feel" of the tree
		LookManager.install( sharedTree );

                treeFrame.getContentPane().add( sharedTree );

                dp.add( treeFrame );

                treeFrame.setBounds( 10, 10, 100, 300 );
                treeFrame.setResizable( true );
                treeFrame.setVisible( true );

                // Editor 1

                DemoInternalFrame2 innerFrame1 = new DemoInternalFrame2( sharedTree, true );

                dp.add( innerFrame1 );

                innerFrame1.setBounds( 150, 10, 200, 300 );
                innerFrame1.setResizable( true );
                innerFrame1.setClosable( true );
                innerFrame1.setVisible( true );

                // Editor 2

		...

    }

XII. Bookmark API

• An icon inside the left bar
  
• A colored bar inside the text
  

• An highligher for drawing the colored bar
• An icon for the left bar
• A bookmark model storing all the mark with BookmarkPosition instances.
  

public class DemoBookmark extends JFrame {

        private BookmarkContext bookmarks;
        private XMLContainer container;       
 

        public DemoBookmark() {
                container = new XMLContainer();
                container.setBookmarkContext(
                                        bookmarks = new DefaultBookmarkContext(
                                        new ImageIcon( getClass().getResource( "bookmark.gif" ) ),
                                        new Color( 200, 200, 250 ) ) );

               // We add an action inside the container toolbar for listing the bookmarked lines
                container.getToolBarModel().addAction(
                                new ListBookmarks() );                
                getContentPane().add( container.getView() );               
        }

        // Action that lists the "bookmarked" lines

        class ListBookmarks extends AbstractAction {

                public ListBookmarks() {
                        putValue( 
				Action.SMALL_ICON, 
				new ImageIcon( getClass().getResource( "bookmark.gif" ) ) );
                }

                public void actionPerformed( ActionEvent e ) {                       

                        XMLDocument doc = container.getDocument(); 
			// We get all the current marks                       
                        BookmarkModel model = bookmarks.getModel();

                        for ( int i = 0; i < model.getBookmarkCount(); i++ ) {
                                BookmarkPosition pos = model.getBookmarkPositionAt( i );
                                int offset = pos.getOffset();
				// We convert the offset to a line number
                                int line = doc.getDefaultRootElement().getElementIndex( offset );
                                System.out.println( "Bookmark at " + line );

                        }
                }
        }

        public static void main(String[] args) {               
                DemoBookmark frame = new DemoBookmark();
                frame.setBounds( 10, 10, 600, 400 );
                frame.setVisible( true );               
        }
}

XIII. Accessing a schema/dtd by a classpath...