com.hcl.domino.data.NotesFont Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of domino-jnx-api-r14 Show documentation
There is a newer version: 1.44.0
/*
 * ==========================================================================
 * Copyright (C) 2019-2022 HCL America, Inc. ( http://www.hcl.com/ )
 *                            All rights reserved.
 * ==========================================================================
 * 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 .
 *
 * 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.hcl.domino.data;

import java.util.Optional;
import java.util.Set;

import com.hcl.domino.richtext.structures.FontStyle;

/**
 * Represents a font definition that is based around settings in a {@link FontStyle}
 * structure and a contextual note.
 * 
 * @author Jesse Gallagher
 * @since 1.0.32
 */
public interface NotesFont {
  /**
   * Retrieves the style attributes set for this font.
   * 
   * @return a {@link Set} of {@link FontAttribute} values
   */
  Set getAttributes();
  
  /**
   * Retrieves the size, in Notes-style points, for this font.
   * 
   * @return the font size in points
   */
  int getPointSize();
  
  /**
   * Retrieves the standard font type specified, if configured as such.
   * 
   * @return an {@link Optional} describing the {@link StandardFonts} value,
   *         or an empty one if this uses a custom font
   */
  Optional getStandardFont();
  
  /**
   * Retrieves the name of the font specified, if not a standard one.
   * 
   * @return an {@link Optional} describing the non-standard font name, or an
   *         empty one if this uses a standard font
   */
  Optional getFontName();
  
  /**
   * Retrieves the color from the standard palette specified, if using one.
   * 
   * @return an {@link Optional} describing the {@link StandardColors} value,
   *         or an emoty one if this uses a non-standard color
   * @since 1.0.34
   */
  Optional getStandardColor();
  
}