All Downloads are FREE. Search and download functionalities are using the official Maven repository.

de.vandermeer.skb.interfaces.document.IsListContext Maven / Gradle / Ivy

There is a newer version: 0.0.2
Show newest version
/* Copyright 2016 Sven van der Meer 
 *
 * 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 de.vandermeer.skb.interfaces.document;

import org.apache.commons.lang3.Validate;

import de.vandermeer.skb.interfaces.objctxt.IsObjectContext;

/**
 * The context (all settings) of a list.
 *
 * @author     Sven van der Meer <[email protected]>
 * @version    v0.0.1 build 170404 (04-Apr-17) for Java 1.8
 * @since      v0.0.1
 */
public interface IsListContext extends IsObjectContext {

	/**
	 * Returns the width of the text in the list (overall width minus any margins etc).
	 * @return text width
	 */
	default int getTextWidth(){
		return this.getTextWidth(this.getWidth());
	}

	/**
	 * Returns the width of the text in the paragraph (overall width minus any margins etc).
	 * @param width a width to calculate the text width for
	 * @return text width
	 */
	int getTextWidth(int width);

	/**
	 * Returns the width set for the list.
	 * @return set width
	 */
	int getWidth();

	/**
	 * Checks a width against the text width (calculated)
	 * @param width the width to check against
	 * @return true if text has at least 1 character
	 * @throws IllegalStateException if the text width is less than 1
	 */
	default boolean checkWidth(int width){
		Validate.validState(this.getTextWidth(width)>0, "text width smaller than 1");
		return (this.getTextWidth(width)>0)?true:false;
	}

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy