com.globalmentor.swing.TextPanel 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.awt.*;
import java.awt.event.ActionEvent;
import java.awt.event.KeyEvent;
import java.io.*;
import javax.swing.*;
import com.globalmentor.awt.BasicGridBagLayout;
import com.globalmentor.net.ContentType;
import com.globalmentor.swing.unicode.UnicodeStatusBar;
import com.globalmentor.text.Text;

/**
 * A panel to edit plain text.
 * @author Garret Wilson
 */
public class TextPanel extends ModelPanel {

	private final JScrollPane scrollPane;
	private final JTextPane textPane;

	/** The status bar showing information about the current Unicode character. */
	private final UnicodeStatusBar unicodeStatusBar;

	/** @return The status bar showing information about the current Unicode character. */
	protected final UnicodeStatusBar getUnicodeStatusBar() {
		return unicodeStatusBar;
	}

	/** The action for displaying Unicode characters. */
	private final UnicodeAction unicodeAction;

	/** @return The action for displaying Unicode characters. */
	public UnicodeAction getUnicodeAction() {
		return unicodeAction;
	}

	/** @return true if the text can be edited. */
	public boolean isEditable() {
		return textPane.isEditable();
	}

	/**
	 * Sets whether or not the text can be edited.
	 * @param editable true if the text can be edited, or false if the information should be read-only.
	 */
	public void setEditable(final boolean editable) {
		textPane.setEditable(editable); //show whether or not the text pane is editable
		textPane.setBackground(editable ? Color.WHITE : Color.LIGHT_GRAY); //set the color to match
		//TODO del		textPane.setEnabled(editable);	//set the enabled status to match
	}

	/** Default constructor. */
	public TextPanel() {
		this(new StringBuilder("")); //construct the panel with no text
	}

	/**
	 * Text model constructor.
	 * @param model The model containing the text to display
	 */
	public TextPanel(final StringBuilder model) {
		super(new BasicGridBagLayout(), model, false); //create the panel with the model without initializing
		//TODO del when works		textPane=new JTextPane();	//create a new text pane
		textPane = new XMLTextPane(); //create a new text pane
		scrollPane = new JScrollPane(textPane); //create the text pane
		unicodeAction = new UnicodeAction(); //create a new Unicode action 
		unicodeStatusBar = new UnicodeStatusBar(); //create a new Unicode status bar
		initialize(); //initialize the panel
		setDefaultFocusComponent(textPane); //set the text pane as the default component
	}

	/** Initialize the user interface. */
	protected void initializeUI() {
		super.initializeUI(); //do the default UI initialization
		textPane.setContentType(ContentType.toString(ContentType.TEXT_PRIMARY_TYPE, Text.PLAIN_SUBTYPE)); //set the content type to "text/plain" TODO maybe allow this panel to support multiple MIME types, and put the setting of the type back into TextResourceKit
		textPane.getDocument().addDocumentListener(getModifyDocumentListener()); //show that we're modified whenever the text is edited (we never change the document, we just load and save text into the document)
		add(scrollPane, BorderLayout.CENTER); //place the text pane, in its scroll pane, in the center of the panel
		add(unicodeStatusBar, BorderLayout.SOUTH); //put the Unicode status bar in the south TODO make this an option
		unicodeStatusBar.attach(textPane); //set the Unicode status bar to track the XML text pane 
	}

	/**
	 * Loads the data from the model to the view, if necessary.
	 * @throws IOException Thrown if there was an error loading the model.
	 */
	public void loadModel() throws IOException {
		super.loadModel(); //do the default loading
		textPane.setText(getModel().toString()); //get the text from the model
	}

	/**
	 * Stores the current data being edited to the model, if necessary.
	 * @throws IOException Thrown if there was an error loading the model.
	 */
	public void saveModel() throws IOException {
		super.saveModel(); //do the default saving
		getModel().replace(0, getModel().length(), textPane.getText()); //change the model's text to whatever is in the text pane 
	}

	/** Action for turning on text antialiasing. */
	protected class UnicodeAction extends AbstractToggleAction {

		/** Default constructor. */
		public UnicodeAction() {
			super("U+"); //create the base class TODO i18n
			putValue(SHORT_DESCRIPTION, "Select Unicode character."); //set the short description TODO Int
			putValue(LONG_DESCRIPTION, "Access the set of Unicode code points."); //set the long description TODO Int
			putValue(MNEMONIC_KEY, new Integer(KeyEvent.VK_U)); //set the mnemonic key TODO i18n
			//TODO fix			putValue(SMALL_ICON, new ImageIcon(ReaderFrame.class.getResource("info.gif")));	//load the correct icon TODO use a constant here
		}

		/**
		 * Called when the action should be performed.
		 * @param actionEvent The event causing the action.
		 */
		public void actionPerformed(final ActionEvent actionEvent) {
			//TODO fix class or del		  setAntialias(!isAntialias()); //turn antialiasing on or off -- the opposite of what it is now
		}
	}

}