com.globalmentor.swing.XMLDocumentFragmentPanel Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of globalmentor-swing Show documentation

GlobalMentor Java Swing library.

The newest version!

/*
 * Copyright © 1996-2009 GlobalMentor, Inc. 
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.globalmentor.swing;

import java.net.URI;
import com.globalmentor.net.*;
import com.globalmentor.xml.XML;
import com.globalmentor.xml.XMLNodeModel;

import org.w3c.dom.*;

/**
 * Panel that displays an XML document fragment and source code.
 * @author Garret Wilson
 */
public class XMLDocumentFragmentPanel extends XMLPanel {

	/**
	 * Initialization constructor.
	 * @param model The data model for which this component provides a view.
	 * @param initialize true if the panel should initialize itself by calling the initialization methods.
	 */
	public XMLDocumentFragmentPanel(final XMLNodeModel model, final boolean initialize) {
		this(model, ContentType.create(ContentType.TEXT_PRIMARY_TYPE, ContentTypeConstants.XML_SUBTYPE), initialize); //construct the panel with a default text/xml media type
	}

	/**
	 * Content type constructor.
	 * @param model The data model for which this component provides a view.
	 * @param mediaType The content type of the XML.
	 */
	public XMLDocumentFragmentPanel(final XMLNodeModel model, final ContentType mediaType) {
		this(model, mediaType, true); //construct and initialize the panel
	}

	/**
	 * Content type and initialization constructor.
	 * @param model The data model for which this component provides a view.
	 * @param mediaType The content type of the XML.
	 * @param initialize true if the panel should initialize itself by calling the initialization methods.
	 */
	public XMLDocumentFragmentPanel(final XMLNodeModel model, final ContentType mediaType, final boolean initialize) {
		super(model, mediaType, false); //construct the parent class without initializing the panel
		if(initialize) //if we should initialize
			initialize(); //initialize the panel
	}

	/**
	 * @return The edited source text, modified as appropriate for the type of model. This version wraps the edited text with a dummy element for creating a
	 *         document fragment.
	 */
	protected String getSourceText() {
		final String sourceText = super.getSourceText(); //get the current source text
		if(sourceText.length() > 0) { //if there is source text
			final StringBuilder sourceStringBuilder = new StringBuilder(); //create a string builder for building the fragment
			sourceStringBuilder.append("\n"); //append the XML prolog TODO use a constant
			sourceStringBuilder.append("'); //finish the root element start tag
			sourceStringBuilder.append(sourceText); //add the source text
			sourceStringBuilder.append("

"); //append the ending tag for the root element to the source code
			return sourceStringBuilder.toString(); //return the source we constructed
		} else { //if there is no source text
			return sourceText; //return the source text (here the empty string) unmodified
		}
	}

	/**
	 * Saves the given document contents to the given model. This version stores a document fragment in the model representing the children of the given
	 * document's document element.
	 * @param model The model to update.
	 * @param document The XML document the contents of which to store in the model.
	 */
	protected void saveModel(final XMLNodeModel model, final Document document) {
		//extract the child elements into a document fragment and set that in the model
		model.setXML(XML.extractChildren(document.getDocumentElement()));
	}

}