Source code

001/*
002 * Copyright (c) 2009, 2013, Oracle and/or its affiliates. All rights reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation.  Oracle designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Oracle in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
022 * or visit www.oracle.com if you need additional information or have any
023 * questions.
024 */
025
026package javafx.scene.shape;
027
028/**
029 * Defines where to draw the stroke around the boundary of a Shape node.
030 *
031 * @see Shape
032 * @since JavaFX 1.3
033 */
034public enum StrokeType {
035
036    /**
037     * The stroke is applied by extending the boundary of the {@link Shape}
038     * node into its interior by a distance specified by the
039     * {@link Shape#strokeWidthProperty strokeWidth}.
040     *
041     * <p>
042     * The image shows a shape without stroke and the same shape with a thick
043     * inside stroke applied.
044     * </p><p>
045     * <img src="doc-files/stroketype-inside.png"/>
046     * </p>
047     */
048    INSIDE,
049
050    /**
051     * The stroke is applied by extending the boundary of the {@link Shape}
052     * node outside of its interior by a distance specified by the
053     * {@link Shape#strokeWidthProperty strokeWidth}.
054     *
055     * <p>
056     * The image shows a shape without stroke and the same shape with a thick
057     * outside stroke applied.
058     * </p><p>
059     * <img src="doc-files/stroketype-outside.png"/>
060     * </p>
061     */
062    OUTSIDE,
063
064    /**
065     * The stroke is applied by extending the boundary of the {@link Shape}
066     * node by a distance of half of the {@link Shape#strokeWidthProperty strokeWidth}
067     * on either side (inside and outside) of the boundary.
068     *
069     * <p>
070     * The image shows a shape without stroke and the same shape with a thick
071     * centered stroke applied.
072     * </p><p>
073     * <img src="doc-files/stroketype-centered.png"/>
074     * </p>
075     */
076    CENTERED
077}