Fx

java.lang.Object
- eve.fx.Fx

```
public class Fx
extends Object
```
This class provides static utilities for imaging and drawing.

Author:

Michael L Brereton

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`FX_OPTION_USE_COMPRESSED_ICONS`
`static int`	`FX_OPTION_USE_ICONS_FOR_ALL_IMAGES`
`static int`	`FX_OPTION_USE_ICONS_FOR_SYSTEM_IMAGES`
`static int`	`fxOptions`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static ISurface`	`createDefaultWindow()`
`static int`	`decodeAlignment(String specs)` Decode alignments that can either be "L" or "R", and default to CENTER if not specified.
`static int`	`decodeAlignment(String specs, int defaultValue)` Decode alignments that can either be "L" or "R", and default to CENTER if not specified.
`static int`	`decodeAnchors(String specs)` Decode anchors that can either be N\|S\|E\|W, and default to CENTER if not specified.
`static int`	`decodeAnchors(String specs, int defaultValue)` Decode anchors that can either be N\|S\|E\|W, and default to CENTER if not specified.
`static int`	`decodeCellConstraints(String specs)` Decode cell constraints that can be h\|H\|v\|V\|F, and default to STRETCH if not specified.
`static int`	`decodeCellConstraints(String specs, int defaultValue)` Decode cell constraints that can be h\|H\|v\|V\|F.
`static int`	`decodeFillConstraintsAndAnchor(String specs)` Decode fill constraints that can be N\|S\|E\|W\|h\|H\|v\|V\|F, and default to STRETCH if not specified.
`static int`	`decodeFillConstraintsAndAnchor(String specs, int defaultValue)` Decode fill constraints that can be N\|S\|E\|W\|h\|H\|v\|V\|F.
`static int`	`getAlphaLevel(int[] values, int offset, int width, int height, int rowStride)` Checks alpha levels of the pixels.
`static String`	`getArialHelvetica()` Get the name of a valid installed Arial or Helvetica font.
`static IConsole`	`getConsole(String title, int buttonsAndOptions, int maxLines)`
`static Font`	`getDefaultFont()`
`static FontMetrics`	`getDefaultFontMetrics()`
`static ISurface`	`getDefaultSurface()`
`static String`	`getDefaultWindowTitle()`
`static FontMetrics`	`getFontMetrics(Font f)` Get a FontMetrics for a particular font, using the default surface.
`static String`	`getMonospacedCourierFont()` Get the name of a valid installed Courier Font that is monospaced.
`static ITaskbarEntry`	`getTaskbarEntry()`
`static String`	`getTimesRoman()` Get the name of a valid installed Times font.
`static boolean`	`isMonospaced(Font f)` For this to return true it must be monospaced AND scalable.
`static boolean`	`isScalable(Font f)`
`static IImage`	`loadPicture(Object source)` Load a Picture given a String name or a FormattedDataSource.
`static void`	`postPicture(String imageName, IImage image)` Put an image into the ImageCache.
`static Handle`	`printerDialog(PropertyList printerProperties)`
`static ImageData`	`scaleImage(ImageData src, int newWidth, int newHeight)`
`static void`	`setFxHandler(IFxHandler handler)`
`static Image`	`toImage(IImage iimage, Rect subArea)` Convert an IImage or portion thereof into an Image optimized for display.
`static Font`	`toMonospacedFont(Font possiblyMonospacedFont, int size)` Find a monospaced Font.
`static boolean`	`yieldToEvents(int max)` Yield to user interface events if possible.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FX_OPTION_USE_ICONS_FOR_SYSTEM_IMAGES
```
public static final int FX_OPTION_USE_ICONS_FOR_SYSTEM_IMAGES
```
    See Also:
    
    Constant Field Values
  - FX_OPTION_USE_ICONS_FOR_ALL_IMAGES
```
public static final int FX_OPTION_USE_ICONS_FOR_ALL_IMAGES
```
    See Also:
    
    Constant Field Values
  - FX_OPTION_USE_COMPRESSED_ICONS
```
public static final int FX_OPTION_USE_COMPRESSED_ICONS
```
    See Also:
    
    Constant Field Values
  - fxOptions
```
public static int fxOptions
```
- Method Detail
  - toImage
```
public static Image toImage(IImage iimage,
                            Rect subArea)
                     throws IllegalArgumentException
```
    Convert an IImage or portion thereof into an Image optimized for display.
    
    Parameters:
    
    iimage - the source IImage.
    
    subArea - an optional sub-area in the image.
    
    Returns:
    
    an Image
    
    Throws:
    
    IllegalArgumentException - if the sub-area is not null but not fully within the source image.
  - isScalable
```
public static boolean isScalable(Font f)
```
  - isMonospaced
```
public static boolean isMonospaced(Font f)
```
    For this to return true it must be monospaced AND scalable.
    
    Parameters:
    
    f - the font to test.
    
    Returns:
    
    true if it is monospaced AND scalable.
  - getMonospacedCourierFont
```
public static String getMonospacedCourierFont()
```
    Get the name of a valid installed Courier Font that is monospaced.
    
    Returns:
    
    the name a valid installed Courier Font that is monospaced or null if none were found.
  - getArialHelvetica
```
public static String getArialHelvetica()
```
    Get the name of a valid installed Arial or Helvetica font.
  - getTimesRoman
```
public static String getTimesRoman()
```
    Get the name of a valid installed Times font.
  - toMonospacedFont
```
public static Font toMonospacedFont(Font possiblyMonospacedFont,
                                    int size)
```
    Find a monospaced Font.
    
    Parameters:
    
    possiblyMonospacedFont - a Font that may be monospaced or null.
    
    size - if possiblyMonospacedFont is null this should be a size for the returned font. Otherwise the size for possiblyMonospacedFont is used.
    
    Returns:
    
    a Font that is monospaced or null if none could be found.
  - getAlphaLevel
```
public static int getAlphaLevel(int[] values,
                                int offset,
                                int width,
                                int height,
                                int rowStride)
```
    Checks alpha levels of the pixels.
    
    Parameters:
    
    values - the pixel values.
    
    offset - the start of the first pixel value.
    
    width - the number of values per lines to check.
    
    height - the number of lines to check.
    
    rowStride - the number of values in a line.
    
    Returns:
    
    0 - indicates all pixels are fully opaque (alpha = 255 for all)
    1 - indicates pixels are either fully opaque or fully transparent (alpha = 255 or 0 for all)
    2 - indicates pixels exist with mixed alpha values (alpha values exist which are not 255 or 0).
  - setFxHandler
```
public static void setFxHandler(IFxHandler handler)
```
  - getDefaultFont
```
public static Font getDefaultFont()
```
  - getDefaultFontMetrics
```
public static FontMetrics getDefaultFontMetrics()
```
  - getFontMetrics
```
public static FontMetrics getFontMetrics(Font f)
```
    Get a FontMetrics for a particular font, using the default surface.
    
    Parameters:
    
    f - the Font.
    
    Returns:
    
    a FontMetrics for the font on the specified surface.
  - getDefaultSurface
```
public static ISurface getDefaultSurface()
```
  - getDefaultWindowTitle
```
public static String getDefaultWindowTitle()
```
  - createDefaultWindow
```
public static ISurface createDefaultWindow()
```
  - loadPicture
```
public static IImage loadPicture(Object source)
```
    Load a Picture given a String name or a FormattedDataSource. If it is a String then it is loaded via the ImageCache.
    
    Parameters:
    
    source - the source of the picture, which should be a name or a FormattedDataSource.
    
    Returns:
    
    an IImage (usually a Picture) representing the Image.
  - postPicture
```
public static void postPicture(String imageName,
                               IImage image)
```
    Put an image into the ImageCache.
    
    Parameters:
    
    imageName -
    
    image -
  - getTaskbarEntry
```
public static ITaskbarEntry getTaskbarEntry()
```
  - yieldToEvents
```
public static boolean yieldToEvents(int max)
```
    Yield to user interface events if possible. This method will call the yieldToEvents() method in the IFxHandler if any is present. If not it returns false.
    
    Parameters:
    
    maxTime - the maximum time to yield for.
    
    Returns:
    
    true if it does know how to yield to events, false if it cannot which means this call has no effect.
  - getConsole
```
public static IConsole getConsole(String title,
                                  int buttonsAndOptions,
                                  int maxLines)
```
  - scaleImage
```
public static ImageData scaleImage(ImageData src,
                                   int newWidth,
                                   int newHeight)
```
  - printerDialog
```
public static Handle printerDialog(PropertyList printerProperties)
```
  - decodeAnchors
```
public static int decodeAnchors(String specs)
```
    Decode anchors that can either be N|S|E|W, and default to CENTER if not specified.
    
    Parameters:
    
    specs - the specification string.
    
    Returns:
    
    the anchor AlignmentConstants.
  - decodeAnchors
```
public static int decodeAnchors(String specs,
                                int defaultValue)
```
    Decode anchors that can either be N|S|E|W, and default to CENTER if not specified.
    
    Parameters:
    
    specs - the specification string.
    
    defaultValue - the default value.
    
    Returns:
    
    the anchor AlignmentConstants.
  - decodeAlignment
```
public static int decodeAlignment(String specs)
```
    Decode alignments that can either be "L" or "R", and default to CENTER if not specified.
    
    Parameters:
    
    specs - the specification string.
    
    Returns:
    
    the alignment AlignmentConstants.
  - decodeAlignment
```
public static int decodeAlignment(String specs,
                                  int defaultValue)
```
    Decode alignments that can either be "L" or "R", and default to CENTER if not specified.
    
    Parameters:
    
    specs - the specification string.
    
    defaultValue - the default value.
    
    Returns:
    
    the alignment AlignmentConstants.
  - decodeCellConstraints
```
public static int decodeCellConstraints(String specs)
```
    Decode cell constraints that can be h|H|v|V|F, and default to STRETCH if not specified.
    
    Parameters:
    
    specs - the specification string.
    
    Returns:
    
    the cell constraints AlignmentConstants.
  - decodeCellConstraints
```
public static int decodeCellConstraints(String specs,
                                        int defaultValue)
```
    Decode cell constraints that can be h|H|v|V|F.
    
    Parameters:
    
    specs - the specification string.
    
    defaultValue - the default value.
    
    Returns:
    
    the cell constraints AlignmentConstants.
  - decodeFillConstraintsAndAnchor
```
public static int decodeFillConstraintsAndAnchor(String specs)
```
    Decode fill constraints that can be N|S|E|W|h|H|v|V|F, and default to STRETCH if not specified.
    
    Parameters:
    
    specs - the specification string.
    
    Returns:
    
    the fill constraints AlignmentConstants.
  - decodeFillConstraintsAndAnchor
```
public static int decodeFillConstraintsAndAnchor(String specs,
                                                 int defaultValue)
```
    Decode fill constraints that can be N|S|E|W|h|H|v|V|F.
    
    Parameters:
    
    specs - the specification string.
    
    defaultValue - the default value.
    
    Returns:
    
    the fill constraints AlignmentConstants.

Class Fx

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FX_OPTION_USE_ICONS_FOR_SYSTEM_IMAGES

FX_OPTION_USE_ICONS_FOR_ALL_IMAGES

FX_OPTION_USE_COMPRESSED_ICONS

fxOptions

Method Detail

toImage

isScalable

isMonospaced

getMonospacedCourierFont

getArialHelvetica

getTimesRoman

toMonospacedFont

getAlphaLevel

setFxHandler

getDefaultFont

getDefaultFontMetrics

getFontMetrics

getDefaultSurface

getDefaultWindowTitle

createDefaultWindow

loadPicture

postPicture

getTaskbarEntry

yieldToEvents

getConsole

scaleImage

printerDialog

decodeAnchors

decodeAnchors

decodeAlignment

decodeAlignment

decodeCellConstraints

decodeCellConstraints

decodeFillConstraintsAndAnchor

decodeFillConstraintsAndAnchor