com.formkiq.vision.document.DocumentText Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2018 FormKiQ 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.formkiq.vision.document;

import org.apache.commons.lang3.Range;

/**
 * 
 * Document Text.
 *
 */
public interface DocumentText extends DocumentBlockRectangle {

	/**
     * @return {@link String}
     */
    String getText();

    /**
     * @return float
     */
    float getFontSize();
    
    /**
     * @return {@link String}
     */
    String getFontName();
    
    /**
     * @return {@link Range}
     */
    default Range toRangeX() {
        return Range.between(Float.valueOf(getLowerLeftX()),
                Float.valueOf(getUpperRightX()));
    }

    /**
     * @return {@link Range}
     */
    default Range toRangeY() {
        return Range.between(Float.valueOf(getLowerLeftY()),
                Float.valueOf(getUpperRightY()));
    }

    /**
     * Set Text.
     * @param text {@link String}
     */
	void setText(String text);

	/**
	 * Set Lower Left X.
	 * @param x float
	 */
	void setLowerLeftX(float x);
	
	/**
	 * Set Upper Right X.
	 * @param x float
	 */
	void setUpperRightX(float x);

	/**
	 * Set Lower Left Y.
	 * @param y float
	 */
	void setLowerLeftY(float y);
	
	/**
	 * Set Upper Right Y.
	 * @param y float
	 */
	void setUpperRightY(float y);
}