com.globalmentor.swing.text.TextComponentFocusTargetAction 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.text;

import java.awt.Component;
import javax.swing.*;
import javax.swing.text.JTextComponent;

import com.globalmentor.swing.FocusTargetAction;

/**
 * Action that only considers focused text components as targets.
 * @author Garret Wilson
 * @see JTextComponent
 */
public abstract class TextComponentFocusTargetAction extends FocusTargetAction {

	/**
	 * Gets the current focus owner.
	 * 
	 * This version only considers focus text components.
	 * 
	 * @return The current focus owner, or null if there is no current focus owner or the focus owner is not a text component.
	 */
	protected Component getFocusOwner() {
		final Component focusOwner = super.getFocusOwner(); //get the default focus owner
		return focusOwner instanceof JTextComponent ? focusOwner : null; //only return the focused component if it is a test component
	}

	/** Default constructor with no default target. */
	public TextComponentFocusTargetAction() {
		super(); //construct the parent
	}

	/**
	 * Name constructor with no default target.
	 * @param name The name description of the action.
	 */
	public TextComponentFocusTargetAction(final String name) {
		super(name); //construct the parent
	}

	/**
	 * Name and target constructor.
	 * @param name The name description of the action.
	 * @param defaultTarget The default target component, or null if there should be no default target.
	 */
	public TextComponentFocusTargetAction(final String name, final JTextComponent defaultTarget) {
		super(name, defaultTarget); //construct the parent
	}

	/**
	 * Name and icon constructor with no default target.
	 * @param name The name description of the action.
	 * @param icon The icon to represent the action.
	 */
	public TextComponentFocusTargetAction(final String name, final Icon icon) {
		super(name, icon); //construct the parent
	}

	/**
	 * Name, icon, and default target constructor.
	 * @param name The name description of the action.
	 * @param icon The icon to represent the action.
	 * @param defaultTarget The default target component, or null if there should be no default target.
	 */
	public TextComponentFocusTargetAction(final String name, final Icon icon, final JTextComponent defaultTarget) {
		super(name, icon, defaultTarget); //construct the parent
	}

}