SwingFactories (Rogue Wave JViews 9.1 API)

java.lang.Object
- ilog.views.util.swing.SwingFactories

All Implemented Interfaces:

SwingConstants
```
public class SwingFactories
extends Object
implements SwingConstants
```
A utility class which provides some useful Swing objects.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SwingFactories.AutoAddComboBoxModel` A `DefaultComboBoxModel` which automatically adds to its list all items trying to be set in the `JComboBox` if they are not already in the list.
`static class`	`SwingFactories.FontListComboBoxModel` A `ComboBoxModel` and `AbstractListModel` containing default font known by the system.
`static class`	`SwingFactories.LnFComboBoxModel` An `AbstractListModel` and a `ComboBoxModel` allowing to list the available L&F.
`static class`	`SwingFactories.LocaleComboBoxModel` An `AbstractListModel` and a `ComboBoxModel` allowing to list the available Locales.
`static class`	`SwingFactories.URLStringChooser` A panel for entering an URL as a String.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static boolean`	`init` Is `true` if the `init()` method has been called.
`protected static boolean`	`initAvailableLocales` Is `true` if the `initAvailableLocales()` method has been called.

Fields inherited from interface javax.swing.SwingConstants
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

Constructor Summary

Constructors
Modifier Constructor and Description

protected SwingFactories()
Creates a new instance of SwingFactories.

Constructors
Modifier	Constructor and Description
`protected`	`SwingFactories()` Creates a new instance of `SwingFactories`.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static File`	`chooseFile(String title, boolean save, boolean directory, File initialFile, Component frame, String approve)` Lets the user choose a file or directory name.
`static File`	`chooseFile(String title, boolean save, boolean directory, String filter, String filterDescription, File initialFile, Component frame, String approve)` Lets the user choose a file or directory name.
`static DefaultComboBoxModel`	`createAutoAddComboBoxModel()` Returns a `ComboBoxModel` which automatically add edited value of the combo box in the list.
`static AbstractColorChooserPanel`	`createColorChooserPanel()` Returns an `AbstractColorChooserPanel` allowing to choose a color in a disk.
`static JComboBox`	`createColorComboBox()` Returns a `JComboBox` enabled to present colors and edit them.
`static Document`	`createDecimalNumberDocument()` Returns a `Document` which can be placed on a `JTextComponent` to enter only digits, and digit separator, for positive numbers (including 0).
`static Document`	`createDecimalNumberDocument(boolean acceptFloatingPoint, boolean acceptNegative)` Returns a `Document` which can be placed on a `JTextComponent` to enter only digits.
`static Document`	`createDecimalNumberDocument(boolean acceptFloatingPoint, boolean acceptNegative, ULocale locale)` Returns a `Document` which can be placed on a `JTextComponent` to enter only digits.
`static Document`	`createDecimalNumberDocument(double minValue, double maxValue, boolean acceptFloatingPoint)` Returns a `Document` which can be placed on a `JTextComponent` to enter numbers.
`static Document`	`createDecimalNumberDocument(double minValue, double maxValue, boolean acceptFloatingPoint, boolean acceptAndShowGroupingSeparator, NumberFormat numberFormat)` Returns a `Document` which can be placed on a `JTextComponent` to enter numbers.
`static Document`	`createDecimalNumberDocument(double minValue, double maxValue, boolean acceptFloatingPoint, NumberFormat numberFormat)` Returns a `Document` which can be placed on a `JTextComponent` to enter numbers.
`static Document`	`createDecimalNumberDocument(double minValue, double maxValue, boolean acceptFloatingPoint, ULocale locale)` Returns a `Document` which can be placed on a `JTextComponent` to enter numbers.
`static ComboBoxModel`	`createFontListComboBoxModel()` Returns a `ComboBoxModel` filled with fonts depending on the JDK version.
`static Box`	`createHorizontalBox()` Returns a box that displays its components in the direction of a line of text, as determined by its `ComponentOrientation` property.
`static ComboBoxModel`	`createLnFComboBoxModel()` Returns a `ComboBoxModel` containing all installed LnFs.
`static ComboBoxModel`	`createLocaleComboBoxModel()` Returns a `ComboBoxModel` containing all available Locales.
`static JComboBox`	`createPaintComboBox()` Returns a `JComboBox` enabled to present paints and edit them.
`static JTabbedPane`	`createTabbedPane()` Returns a new instance of a tabbed pane with `JTabbedPane.SCROLL_TAB_LAYOUT`.
`static JTextField`	`createTextField(Document doc, String text, int columns)` Returns a subclass of `javax.swing.JTextField` that validates the editing also on focus lost.
`static JTextField`	`createTextField(String text)` Returns a subclass of `javax.swing.JTextField` that validates the editing also on focus lost.
`static Box`	`createVerticalBox()` Returns a box that displays its components in the direction of a page of text, as determined by its `ComponentOrientation` property.
`static int`	`getBoxLayoutLineAxis()` Returns the axis for the BoxLayout to layout components in the direction of a line of text.
`static int`	`getBoxLayoutPageAxis()` Returns the axis for the BoxLayout to layout components in the direction of a page of text.
`static File`	`getCurrentDirectory()` Returns the current directory of the shared file chooser dialog box.
`static double`	`getDoubleFromNumberTextComponent(JTextComponent component)` Returns the double number stored in the text component that is controlled by a document created by `createDecimalNumberDocument()`.
`static Frame`	`getFrame(Component c)` Returns the Frame window of the component.
`static int`	`getGridBagLayoutLineEnd()` Returns the value for the "anchor" of a grid bag constraint that aligns the component to the end of the line.
`static int`	`getGridBagLayoutLineStart()` Returns the value for the "anchor" of a grid bag constraint that aligns the component to the start of the line.
`static Dimension`	`getIconComboBoxPreferredSize(JComboBox combo, Dimension superPreferredSize)` Returns the preferred size of a combo box that contains Icons.
`static long`	`getLongFromNumberTextComponent(JTextComponent component)` Returns the long number stored in the text component that is controlled by a document created by `createDecimalNumberDocument()`.
`static NumberFormat`	`getNumberFormatFromDecimalNumberDocument(Document doc)` Returns the number format of the input document.
`static Number`	`getNumberFromDecimalNumberDocument(Document doc)` Returns the number representation of the value contained in the input document.
`static FileFilter`	`getSelectedFileFilter()` Returns the index of the selected file filter.
`static String`	`getStringForDecimalNumberDocument(Document doc, double value)` Returns the string representation of the input value that is suitable for the input document.
`static String`	`getStringForNumberTextComponent(JTextComponent component, double value)` Returns the string representation of the input value that is suitable for the text component that is controlled by a document created by `createDecimalNumberDocument()`.
`static void`	`init()` This method allows you to initialize in advance, at a time point of your choice, the `JFileChooser` instance needed by some methods of this class.
`static void`	`initAvailableLocales()` This method allows you to initialize in advance, at a time point of your choice, the list of available locales needed by the method `createLocaleComboBoxModel()` and by the class `SwingFactories.LocaleComboBoxModel`.
`static void`	`setCurrentDirectory(File dir)` Sets the current directory of the shared file chooser dialog box.
`static void`	`setFileFilters(FileFilter[] filter, int selected)` Sets the file filters of the shared file chooser dialog box and set which one is selected.

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

- Field Detail
  - init
```
protected static boolean init
```
    Is true if the init() method has been called.
  - initAvailableLocales
```
protected static boolean initAvailableLocales
```
    Is true if the initAvailableLocales() method has been called.
    
    Since:
    
    JViews 7.5
- Constructor Detail
  - SwingFactories
```
protected SwingFactories()
```
    Creates a new instance of SwingFactories.
- Method Detail
  - init
```
public static void init()
```
    This method allows you to initialize in advance, at a time point of your choice, the JFileChooser instance needed by some methods of this class. The initialization is relatively costly. If this method is not called in advance, the initialization will be done automatically when it is needed.
  - initAvailableLocales
```
public static void initAvailableLocales()
```
    This method allows you to initialize in advance, at a time point of your choice, the list of available locales needed by the method createLocaleComboBoxModel() and by the class SwingFactories.LocaleComboBoxModel. The initialization is relatively costly. If this method is not called in advance, the initialization will be done automatically when it is needed.
    
    Since:
    
    JViews 7.5
  - createTabbedPane
```
public static JTabbedPane createTabbedPane()
```
    Returns a new instance of a tabbed pane with JTabbedPane.SCROLL_TAB_LAYOUT.
  - createDecimalNumberDocument
```
public static Document createDecimalNumberDocument()
```
    Returns a Document which can be placed on a JTextComponent to enter only digits, and digit separator, for positive numbers (including 0).
  - createDecimalNumberDocument
```
public static Document createDecimalNumberDocument(boolean acceptFloatingPoint,
                                                   boolean acceptNegative)
```
    Returns a Document which can be placed on a JTextComponent to enter only digits.
    
    Parameters:
    
    acceptFloatingPoint - Whether floating points are accepted.
    
    acceptNegative - Whether negative numbers are accepted.
    
    Returns:
    
    The document for the JTextComponent.
  - createDecimalNumberDocument
```
public static Document createDecimalNumberDocument(boolean acceptFloatingPoint,
                                                   boolean acceptNegative,
                                                   ULocale locale)
```
    Returns a Document which can be placed on a JTextComponent to enter only digits. Grouping separators in numbers are accepted but filtered out.
    
    Parameters:
    
    acceptFloatingPoint - Whether floating points are accepted.
    
    acceptNegative - Whether negative numbers are accepted.
    
    locale - The desired locale, that defined the number format.
    
    Returns:
    
    The document for the JTextComponent.
    
    Since:
    
    JViews 8.8
  - createDecimalNumberDocument
```
public static Document createDecimalNumberDocument(double minValue,
                                                   double maxValue,
                                                   boolean acceptFloatingPoint)
```
    Returns a Document which can be placed on a JTextComponent to enter numbers. Grouping separators in numbers are accepted but filtered out.
    
    Parameters:
    
    minValue - The minimum accepted value. Use -Double.MAX_VALUE to indicate there is no minimum value.
    
    maxValue - The maximum accepted value. Use Double.MAX_VALUE to indicate there is no maximum value.
    
    acceptFloatingPoint - If true, decimals are accepted, otherwise decimal dot is filtered.
    
    Returns:
    
    The document for the JTextComponent.
  - createDecimalNumberDocument
```
public static Document createDecimalNumberDocument(double minValue,
                                                   double maxValue,
                                                   boolean acceptFloatingPoint,
                                                   ULocale locale)
```
    Returns a Document which can be placed on a JTextComponent to enter numbers. Grouping separators in numbers are accepted but filtered out.
    
    Parameters:
    
    minValue - The minimum accepted value. Use -Double.MAX_VALUE to indicate there is no minimum value.
    
    maxValue - The maximum accepted value. Use Double.MAX_VALUE to indicate there is no maximum value.
    
    acceptFloatingPoint - If true, decimals are accepted, otherwise decimal dot is filtered.
    
    locale - The desired locale, that defined the number format.
    
    Returns:
    
    The document for the JTextComponent.
    
    Since:
    
    JViews 8.8
  - createDecimalNumberDocument
```
public static Document createDecimalNumberDocument(double minValue,
                                                   double maxValue,
                                                   boolean acceptFloatingPoint,
                                                   NumberFormat numberFormat)
```
    Returns a Document which can be placed on a JTextComponent to enter numbers. Grouping separators in numbers are accepted but filtered out.
    
    Parameters:
    
    minValue - The minimum accepted value. Use -Double.MAX_VALUE to indicate there is no minimum value.
    
    maxValue - The maximum accepted value. Use Double.MAX_VALUE to indicate there is no maximum value.
    
    acceptFloatingPoint - If true, decimals are accepted, otherwise decimal dot is filtered.
    
    numberFormat - The NumberFormat instance to be used for checking the format of the entered string. It may be destructively modified, but the enclosed DecimalFormatSymbols object (if a DecimalFormat is passed) will not be destructively modified. If null, the non-localized format is used ("." is considered as decimal separator).
    
    Returns:
    
    The document for the JTextComponent.
  - createDecimalNumberDocument
```
public static Document createDecimalNumberDocument(double minValue,
                                                   double maxValue,
                                                   boolean acceptFloatingPoint,
                                                   boolean acceptAndShowGroupingSeparator,
                                                   NumberFormat numberFormat)
```
    Returns a Document which can be placed on a JTextComponent to enter numbers. Grouping separators in numbers are accepted but filtered out.
    
    Parameters:
    
    minValue - The minimum accepted value. Use -Double.MAX_VALUE to indicate there is no minimum value.
    
    maxValue - The maximum accepted value. Use Double.MAX_VALUE to indicate there is no maximum value.
    
    acceptFloatingPoint - If true, decimals are accepted, otherwise decimal dot is filtered.
    
    acceptAndShowGroupingSeparator - If true, grouping separators are accepted and remain in the string. If false, grouping separators are accepted but filtered out: for instance, in English, the number 123,456,789 can be entered but is stored in the document as 123456789.
    
    numberFormat - The NumberFormat instance to be used for checking the format of the entered string. It may be destructively modified, but the enclosed DecimalFormatSymbols object (if a DecimalFormat is passed) will not be destructively modified. If null, the non-localized format is used ("." is considered as decimal
    
    Returns:
    
    The document for the JTextComponent.
    
    Since:
    
    JViews 8.8
  - getStringForNumberTextComponent
```
public static String getStringForNumberTextComponent(JTextComponent component,
                                                     double value)
```
    Returns the string representation of the input value that is suitable for the text component that is controlled by a document created by createDecimalNumberDocument().
    
    Parameters:
    
    component - The text component.
    
    value - The value.
    
    Returns:
    
    The String representation of the value.
    
    Since:
    
    JViews 8.8
  - getDoubleFromNumberTextComponent
```
public static double getDoubleFromNumberTextComponent(JTextComponent component)
                                               throws NumberFormatException,
                                                      ParseException
```
    Returns the double number stored in the text component that is controlled by a document created by createDecimalNumberDocument().
    
    Parameters:
    
    component - The text component.
    
    Returns:
    
    The double value.
    
    Throws:
    
    NumberFormatException
    
    ParseException
    
    Since:
    
    JViews 8.8
  - getLongFromNumberTextComponent
```
public static long getLongFromNumberTextComponent(JTextComponent component)
                                           throws NumberFormatException,
                                                  ParseException
```
    Returns the long number stored in the text component that is controlled by a document created by createDecimalNumberDocument().
    
    Parameters:
    
    component - The text component.
    
    Returns:
    
    The long value.
    
    Throws:
    
    NumberFormatException
    
    ParseException
    
    Since:
    
    JViews 8.8
  - getStringForDecimalNumberDocument
```
public static String getStringForDecimalNumberDocument(Document doc,
                                                       double value)
```
    Returns the string representation of the input value that is suitable for the input document. The input document should be once created by createDecimalNumberDocument().
    
    Parameters:
    
    doc - The number document.
    
    value - The value.
    
    Returns:
    
    The String representation of the value.
    
    Since:
    
    JViews 8.8
  - getNumberFromDecimalNumberDocument
```
public static Number getNumberFromDecimalNumberDocument(Document doc)
                                                 throws NumberFormatException,
                                                        ParseException
```
    Returns the number representation of the value contained in the input document. The input document should be once created by createDecimalNumberDocument().
    
    Parameters:
    
    doc - The number document.
    
    Returns:
    
    The value of the document.
    
    Throws:
    
    NumberFormatException
    
    ParseException
    
    Since:
    
    JViews 8.8
  - getNumberFormatFromDecimalNumberDocument
```
public static NumberFormat getNumberFormatFromDecimalNumberDocument(Document doc)
```
    Returns the number format of the input document. The input document should be once created by createDecimalNumberDocument().
    
    Parameters:
    
    doc - The number document.
    
    Returns:
    
    The number format, or null.
    
    Since:
    
    JViews 8.8
  - createTextField
```
public static JTextField createTextField(String text)
```
    Returns a subclass of javax.swing.JTextField that validates the editing also on focus lost. The textfield is initialized with the specified text. A default model is created and the number of columns is 0.
    
    Parameters:
    
    text - The initial string to display, or null.
    
    Since:
    
    JViews 8.1
  - createTextField
```
public static JTextField createTextField(Document doc,
                                         String text,
                                         int columns)
```
    Returns a subclass of javax.swing.JTextField that validates the editing also on focus lost. The created textfield uses the given text storage model and the given number of columns. If the document is null, a default model is created.
    
    Parameters:
    
    doc - The text storage to use; if this is null, a default will be provided.
    
    text - The initial string to display, or null.
    
    columns - The number of columns to use to calculate the preferred width >= 0; if columns is set to zero, the preferred width will be whatever naturally results from the component implementation.
    
    Throws:
    
    IllegalArgumentException - if columns < 0
    
    Since:
    
    JViews 8.1
  - createFontListComboBoxModel
```
public static ComboBoxModel createFontListComboBoxModel()
```
    Returns a ComboBoxModel filled with fonts depending on the JDK version.
  - createLnFComboBoxModel
```
public static ComboBoxModel createLnFComboBoxModel()
```
    Returns a ComboBoxModel containing all installed LnFs.
  - createLocaleComboBoxModel
```
public static ComboBoxModel createLocaleComboBoxModel()
```
    Returns a ComboBoxModel containing all available Locales.
  - createColorComboBox
```
public static JComboBox createColorComboBox()
```
    Returns a JComboBox enabled to present colors and edit them.
  - createPaintComboBox
```
public static JComboBox createPaintComboBox()
```
    Returns a JComboBox enabled to present paints and edit them.
  - createAutoAddComboBoxModel
```
public static DefaultComboBoxModel createAutoAddComboBoxModel()
```
    Returns a ComboBoxModel which automatically add edited value of the combo box in the list.
  - createColorChooserPanel
```
public static AbstractColorChooserPanel createColorChooserPanel()
```
    Returns an AbstractColorChooserPanel allowing to choose a color in a disk. It allows to set the alpha value (transparency) of the color object. You can add this object to a JColorChooser using the addChooserPanel method.
  - chooseFile
```
public static File chooseFile(String title,
                              boolean save,
                              boolean directory,
                              String filter,
                              String filterDescription,
                              File initialFile,
                              Component frame,
                              String approve)
```
    Lets the user choose a file or directory name. This method uses a shared instance of a JFileChooser. That's why it is not thread safe and as always in Swing to prevent such problems it should always be called from the event handling thread (in answer to a user action).
    
    Parameters:
    
    title - the file chooser1's title.
    
    save - if true, choose a file for saving.
    
    directory - if true, choose a directory instead of a file.
    
    filter - The file filter, a suffix string starting with ".", or null.
    
    filterDescription - The textual description of the file filter, or null.
    
    initialFile - the initial file name.
    
    frame - the parent component of the dialog or null.
    
    approve - the text used in the "approve" button.
    
    See Also:
    
    init()
  - setCurrentDirectory
```
public static void setCurrentDirectory(File dir)
```
    Sets the current directory of the shared file chooser dialog box.
  - getCurrentDirectory
```
public static File getCurrentDirectory()
```
    Returns the current directory of the shared file chooser dialog box.
  - setFileFilters
```
public static void setFileFilters(FileFilter[] filter,
                                  int selected)
```
    Sets the file filters of the shared file chooser dialog box and set which one is selected.
    
    See Also:
    
    init()
  - getSelectedFileFilter
```
public static FileFilter getSelectedFileFilter()
```
    Returns the index of the selected file filter.
    
    See Also:
    
    init()
  - chooseFile
```
public static File chooseFile(String title,
                              boolean save,
                              boolean directory,
                              File initialFile,
                              Component frame,
                              String approve)
```
    Lets the user choose a file or directory name. It uses the shared file chooser dialog box.
    
    See Also:
    
    chooseFile(java.lang.String, boolean, boolean, java.lang.String, java.lang.String, java.io.File, java.awt.Component, java.lang.String), init()
  - getFrame
```
public static Frame getFrame(Component c)
```
    Returns the Frame window of the component. If no Frame parent is found returns null.
  - createHorizontalBox
```
public static Box createHorizontalBox()
```
    Returns a box that displays its components in the direction of a line of text, as determined by its ComponentOrientation property.
    
    Returns:
    
    a Box.
  - createVerticalBox
```
public static Box createVerticalBox()
```
    Returns a box that displays its components in the direction of a page of text, as determined by its ComponentOrientation property.
    
    Returns:
    
    a Box.
  - getBoxLayoutLineAxis
```
public static int getBoxLayoutLineAxis()
```
    Returns the axis for the BoxLayout to layout components in the direction of a line of text.
  - getBoxLayoutPageAxis
```
public static int getBoxLayoutPageAxis()
```
    Returns the axis for the BoxLayout to layout components in the direction of a page of text.
  - getGridBagLayoutLineStart
```
public static int getGridBagLayoutLineStart()
```
    Returns the value for the "anchor" of a grid bag constraint that aligns the component to the start of the line.
  - getGridBagLayoutLineEnd
```
public static int getGridBagLayoutLineEnd()
```
    Returns the value for the "anchor" of a grid bag constraint that aligns the component to the end of the line.
  - getIconComboBoxPreferredSize
```
public static Dimension getIconComboBoxPreferredSize(JComboBox combo,
                                                     Dimension superPreferredSize)
```
    Returns the preferred size of a combo box that contains Icons.
    
    Parameters:
    
    combo - The combo box.
    
    superPreferredSize - The preferred size returned by the JDK, that is, the result of super.getPreferredSize() on the combo.

Class SwingFactories

Nested Class Summary

Field Summary

Fields inherited from interface javax.swing.SwingConstants

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

init

initAvailableLocales

Constructor Detail

SwingFactories

Method Detail

init

initAvailableLocales

createTabbedPane

createDecimalNumberDocument

createDecimalNumberDocument

createDecimalNumberDocument

createDecimalNumberDocument

createDecimalNumberDocument

createDecimalNumberDocument

createDecimalNumberDocument

getStringForNumberTextComponent

getDoubleFromNumberTextComponent

getLongFromNumberTextComponent

getStringForDecimalNumberDocument

getNumberFromDecimalNumberDocument

getNumberFormatFromDecimalNumberDocument

createTextField

createTextField

createFontListComboBoxModel

createLnFComboBoxModel

createLocaleComboBoxModel

createColorComboBox

createPaintComboBox

createAutoAddComboBoxModel

createColorChooserPanel

chooseFile

setCurrentDirectory

getCurrentDirectory

setFileFilters

getSelectedFileFilter

chooseFile

getFrame

createHorizontalBox

createVerticalBox

getBoxLayoutLineAxis

getBoxLayoutPageAxis

getGridBagLayoutLineStart

getGridBagLayoutLineEnd

getIconComboBoxPreferredSize