io.guise.framework.component.layout.Border 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.layout;

import static java.util.Objects.*;

/**
 * The points at which the four logical flows end.
 * @author Garret Wilson
 * @see io.guise.framework.geometry.Side
 */
public enum Border {

	/** The left side in left-to-right top-to-bottom orientation. */
	LINE_NEAR(Flow.LINE, Flow.End.NEAR),
	/** The right side in left-to-right top-to-bottom orientation. */
	LINE_FAR(Flow.LINE, Flow.End.FAR),
	/** The top side in left-to-right top-to-bottom orientation. */
	PAGE_NEAR(Flow.PAGE, Flow.End.NEAR),
	/** The bottom side in left-to-right top-to-bottom orientation. */
	PAGE_FAR(Flow.PAGE, Flow.End.FAR);

	/** The flow. */
	private final Flow flow;

	/** @return The flow. */
	public Flow getFlow() {
		return flow;
	}

	/** The end. */
	private final Flow.End end;

	/** @return The end. */
	public Flow.End getEnd() {
		return end;
	}

	/**
	 * Flow and end constructor.
	 * @param flow The flow
	 * @param end The end.
	 * @throws NullPointerException if the given flow and/or end is null.
	 */
	private Border(final Flow flow, final Flow.End end) {
		this.flow = requireNonNull(flow, "Flow cannot be null.");
		this.end = requireNonNull(end, "End cannot be null.");
	}

	/** The borders in [flow][end] order. */
	private static final Border[][] FLOW_END_BORDERS = new Border[][] { { LINE_NEAR, LINE_FAR }, { PAGE_NEAR, PAGE_FAR } };

	/**
	 * Determines the border from the flow and end.
	 * @param flow The flow
	 * @param end The end.
	 * @return The border for the specified flow and page end.
	 * @throws NullPointerException if the given flow and/or end is null.
	 */
	public static Border getBorder(final Flow flow, final Flow.End end) {
		return FLOW_END_BORDERS[flow.ordinal()][end.ordinal()]; //look up the border in our array
	}
}