org.jfree.fx.FXHints Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of fxgraphics2d Show documentation
Show all versions of fxgraphics2d Show documentation
FXGraphics2D is an API that provides a Graphics2D implementation
that targets the JavaFX Canvas. This allows existing Java2D code to
be reused with JavaFX.
/* ============
* FXGraphics2D
* ============
*
* (C)opyright 2014-2017, by Object Refinery Limited.
*
* http://www.jfree.org/fxgraphics2d/index.html
*
* The FXGraphics2D class has been developed by Object Refinery Limited for
* use in Orson Charts (http://www.object-refinery.com/orsoncharts) and
* JFreeChart (http://www.jfree.org/jfreechart). It may be useful for other
* code that uses the Graphics2D API provided by Java2D.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* - Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* - Neither the name of the Object Refinery Limited nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL OBJECT REFINERY LIMITED BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
package org.jfree.fx;
import java.awt.RenderingHints;
/**
* Defines the rendering hints that can be used with the {@link FXGraphics2D}
* class. There is just one hint defined at present:
*
* - {@link #KEY_USE_FX_FONT_METRICS} that controls whether the
* generate output (regular text or vector graphics);
*
*
* @since 1.5
*/
public final class FXHints {
private FXHints() {
// no need to instantiate this
}
/**
* The key for the hint that controls whether JavaFX font metrics are
* used (better matching to rendering engine, but relies on deprecated API)
* or Java2D font metrics. A {@code Boolean} value (or {@code null}) can
* be assigned as the value for this key.
*
* @deprecated As of version 1.6, this hint does nothing (because the
* implementation cannot be supported on JDK9).
*/
public static final FXHints.Key KEY_USE_FX_FONT_METRICS
= new FXHints.Key(0);
/**
* A key for hints used by the {@link FXGraphics2D} class.
*/
public static class Key extends RenderingHints.Key {
public Key(int privateKey) {
super(privateKey);
}
/**
* Returns {@code true} if {@code val} is a value that is
* compatible with this key, and {@code false} otherwise.
*
* @param val the value.
*
* @return A boolean.
*/
@Override
public boolean isCompatibleValue(Object val) {
switch (intKey()) {
case 0:
return val == null
|| val instanceof Boolean;
default:
throw new RuntimeException("Not expected!");
}
}
}
}