io.guise.framework.component.HeadingComponent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of guise-framework Show documentation

Guise™ Internet application framework.

There is a newer version: 0.5.3

/*
 * Copyright © 2005-2008 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 io.guise.framework.component;

import static com.globalmentor.java.Classes.*;

/**
 * A component meant to be a heading. A heading provides a zero-based logical level of hierarchical nesting, with lower levels indicating headings of larger
 * groupings of information.
 * @author Garret Wilson
 */
public interface HeadingComponent extends Component {

	/** The heading level value indicating no heading level. */
	public static final int NO_HEADING_LEVEL = -1;

	/** The level bound property. */
	public static final String LEVEL_PROPERTY = getPropertyName(HeadingComponent.class, "level");

	/** @return The zero-based level of the heading, or {@link HeadingComponent#NO_HEADING_LEVEL} if no level is specified. */
	public int getLevel();

	/**
	 * Sets the level of the heading. This is a bound property of type Integer.
	 * @param newLevel The new zero-based heading level, or {@link HeadingComponent#NO_HEADING_LEVEL} if no level is specified.
	 * @see HeadingComponent#LEVEL_PROPERTY
	 */
	public void setLevel(final int newLevel);

}