javafx.scene.text.TextBoundsType Maven / Gradle / Ivy
Show all versions of openjfx-78-backport Show documentation
/*
* Copyright (c) 2009, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package javafx.scene.text;
/**
* Specifies the behaviour of bounds reporting by {@code Text} nodes.
* The setting affects {@code layoutBounds}, {@code boundsInLocal} and
* {@code boundsInParent}
*
* The geometry of text can be measured either in terms of the bounds of
* the particular text to be rendered - visual bounds, or as properties
* of the font and the characters to be rendered - logical bounds.
* Visual bounds are more useful for positioning text as graphics, and
* for obtaining tight enclosing bounds around the text.
*
* Logical bounds are important for laying out text relative to other
* text and other components, particularly those which also contain text.
* The bounds isn't specific to the text being rendered, and so will
* report heights which account for the potential ascent and descent of
* text using the font at its specified size. Also leading and trailing
* spaces are part of the logical advance width of the text.
*
*
* @since JavaFX 2.0
*/
public enum TextBoundsType {
/**
* Use logical bounds as the basis for calculating the bounds.
*
* The logical bounds are based on font metrics information. The width is
* based on the glyph advances and the height on the ascent, descent, and
* line gap. Except for the last line which does not include the line gap.
*
* Note: This is usually the fastest option.
*/
LOGICAL,
/**
* Use visual bounds as the basis for calculating the bounds.
*
* Note: This is likely to be slower than using logical bounds.
*/
VISUAL,
/**
* Use logical vertical centered bounds as the basis for calculating the bounds.
*
* This bounds type is typically used to center {@code Text} nodes vertically
* within the bounds of its parent.
* @since JavaFX 8.0
*/
LOGICAL_VERTICAL_CENTER
}