poi/src/java/org/apache/poi/ss/usermodel/FontFormatting.java

/*
 *  ====================================================================
 *    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.ss.usermodel;

import org.apache.poi.util.Removal;

/**
 * High level representation for Font Formatting component
 * of Conditional Formatting settings
 */
public interface FontFormatting {
    // TODO: refactor and unify Font & FontFormatting in POI 5.0.0

    /**
     * Escapement type - None
     *
     * @deprecated use {@link Font#SS_NONE} instead
     */
    @Deprecated
    @Removal(version = "5.0.0")
    short SS_NONE  = 0;
    /**
     * Escapement type - Superscript
     *
     * @deprecated use {@link Font#SS_SUPER} instead
     */
    @Deprecated
    @Removal(version = "5.0.0")
    short SS_SUPER = 1;
    /**
     * Escapement type - Subscript
     *
     * @deprecated use {@link Font#SS_SUB} instead
     */
    @Deprecated
    @Removal(version = "5.0.0")
    short SS_SUB   = 2;

    /**
     * Underline type - None
     *
     * @deprecated use {@link Font#U_NONE} instead
     */
    @Deprecated
    @Removal(version = "5.0.0")
    byte U_NONE              = 0;
    /**
     * Underline type - Single
     *
     * @deprecated use {@link Font#U_SINGLE} instead
     */
    @Deprecated
    @Removal(version = "5.0.0")
    byte U_SINGLE            = 1;
    /**
     * Underline type - Double
     *
     * @deprecated use {@link Font#U_DOUBLE} instead
     */
    @Deprecated
    @Removal(version = "5.0.0")
    byte U_DOUBLE            = 2;
    /**
     * Underline type - Single Accounting
     *
     * @deprecated use {@link Font#U_SINGLE_ACCOUNTING} instead
     */
    @Deprecated
    @Removal(version = "5.0.0")
    byte U_SINGLE_ACCOUNTING = 0x21;
    /**
     * Underline type - Double Accounting
     *
     * @deprecated use {@link Font#U_DOUBLE_ACCOUNTING} instead
     */
    @Deprecated
    @Removal(version = "5.0.0")
    byte U_DOUBLE_ACCOUNTING = 0x22;

    /**
     * get the type of super or subscript for the font
     *
     * @return super or subscript option
     * @see Font#SS_NONE
     * @see Font#SS_SUPER
     * @see Font#SS_SUB
     */
    short getEscapementType();

    /**
     * set the escapement type for the font
     *
     * @param escapementType  super or subscript option
     * @see Font#SS_NONE
     * @see Font#SS_SUPER
     * @see Font#SS_SUB
     */
    void setEscapementType(short escapementType);

    /**
     * @return font colour index, or 0 if not indexed (XSSF only)
     */
    short getFontColorIndex();

    /**
     * Sets the indexed colour to use
     * @param color font colour index
     */
    void setFontColorIndex(short color);

    /**
     * @return The colour of the font, or null if no colour applied
     */
    Color getFontColor();

    /**
     * Sets the colour to use
     * @param color font colour to use
     */
    void setFontColor(Color color);

    /**
     * gets the height of the font in 1/20th point units
     *
     * @return fontheight (in points/20); or -1 if not modified
     */
    int getFontHeight();

    /**
     * Sets the height of the font in 1/20th point units
     *
     * @param height the height in twips (in points/20)
     */
    void setFontHeight(int height);

    /**
     * get the type of underlining for the font
     *
     * @return font underlining type
     *
     * @see Font#U_NONE
     * @see Font#U_SINGLE
     * @see Font#U_DOUBLE
     * @see Font#U_SINGLE_ACCOUNTING
     * @see Font#U_DOUBLE_ACCOUNTING
     */
    short getUnderlineType();

    /**
     * set the type of underlining type for the font
     *
     * @param underlineType  super or subscript option
     *
     * @see Font#U_NONE
     * @see Font#U_SINGLE
     * @see Font#U_DOUBLE
     * @see Font#U_SINGLE_ACCOUNTING
     * @see Font#U_DOUBLE_ACCOUNTING
     */
    void setUnderlineType(short underlineType);

    /**
     * get whether the font weight is set to bold or not
     *
     * @return bold - whether the font is bold or not
     */
    boolean isBold();

    /**
     * @return true if font style was set to <i>italic</i>
     */
    boolean isItalic();


    /**
     * @return true if font strikeout is on
     */
    boolean isStruckout();

    /**
     * set font style options.
     *
     * @param italic - if true, set posture style to italic, otherwise to normal
     * @param bold if true, set font weight to bold, otherwise to normal
     */
    void setFontStyle(boolean italic, boolean bold);

    /**
     * set font style options to default values (non-italic, non-bold)
     */
    void resetFontStyle();
}