org.apache.poi.xssf.usermodel.TextAutofit Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of poi-ooxml Show documentation

Apache POI - Java API To Access Microsoft Format Files

There is a newer version: 5.2.5

/*
 *  ====================================================================
 *    Licensed to the Apache Software Foundation (ASF) under one or more
 *    contributor license agreements.  See the NOTICE file distributed with
 *    this work for additional information regarding copyright ownership.
 *    The ASF licenses this file to You 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 org.apache.poi.xssf.usermodel;

/**
 * Specifies a list of auto-fit types.
 * 
 * Autofit specifies that a shape should be auto-fit to fully contain the text described within it.
 * Auto-fitting is when text within a shape is scaled in order to contain all the text inside
 * 
 */
public enum TextAutofit {
    /**
     * Specifies that text within the text body should not be auto-fit to the bounding box.
     * Auto-fitting is when text within a text box is scaled in order to remain inside
     * the text box.
     */
    NONE,
    /**
     * Specifies that text within the text body should be normally auto-fit to the bounding box.
     * Autofitting is when text within a text box is scaled in order to remain inside the text box.
     *
     * 
     * Example: Consider the situation where a user is building a diagram and needs
     * to have the text for each shape that they are using stay within the bounds of the shape.
     * An easy way this might be done is by using NORMAL autofit
     * 
     */
    NORMAL,
    /**
     * Specifies that a shape should be auto-fit to fully contain the text described within it.
     * Auto-fitting is when text within a shape is scaled in order to contain all the text inside.
     *
     * 
     * Example: Consider the situation where a user is building a diagram and needs to have
     * the text for each shape that they are using stay within the bounds of the shape.
     * An easy way this might be done is by using SHAPE autofit
     * 
     */
    SHAPE
}