com.globalmentor.swing.text.ViewsFactory 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.util.List;

import javax.swing.text.*;

/**
 * Indicates that this factory can create multiple views for one element if it needs to, allowing a hierarchy of views to be represented by one level of
 * multiple views, for example.
 * @author Garret Wilson
 */
public interface ViewsFactory extends ViewFactory {

	/**
	 * Creates one or more views for the given element, storing the views in the given list. This method allows one element (such as a nested inline element
	 * within a paragraph) to be represented by one level of multiple views rather than a hierarchy of views.
	 * @param element The element the view or views will represent.
	 * @param addViewList The list of views to which the views should be added.
	 */
	public void create(final Element element, final List addViewList);

	/**
	 * Creates a view for the given element. This method can optionally indicate multiple views are needed by returning null.
	 * @param element The element this view will represent.
	 * @param indicateMultipleViews Whether null should be returned to indicate multiple views should represent the given element.
	 * @return A view to represent the given element, or null indicating the element should be represented by multiple views.
	 */
	public View create(final Element element, final boolean indicateMultipleViews);

}