IGuiFactory (External Module API 1.5.2 Documentation

```
public interface IGuiFactory
```
(Swing) GUI factory interface.
Used to create new instances of GUI API interfaces.

For a consistent UI and user experience it is strongly recommended to use extended components offered here whenever possible. Also these extended components follow the user interface related settings.
You can mix extended components offered by the API and "basic" Swing components, but by using basic Swing components you'll lose the extra functionality provided by the extended components - and future ones that will be added in the future.

For components that are initialized from setting values or are bound to them, please see ISettingsGui.

Author:

Andras Belicza

See Also:
IFactory, ISettingsGui

Method Summary

Methods
Modifier and Type	Method and Description
`IAction`	`newAction(IRIcon ricon, java.lang.String text, java.awt.event.ActionListener listener)` Creates a new `IAction`.
`IAction`	`newAction(IRIcon ricon, java.lang.String text, javax.swing.JComponent comp, java.awt.event.ActionListener listener)` Creates a new `IAction`.
`IAction`	`newAction(javax.swing.KeyStroke keyStroke, IRIcon ricon, java.lang.String text, java.awt.event.ActionListener listener)` Creates a new `IAction`.
`IAction`	`newAction(javax.swing.KeyStroke keyStroke, IRIcon ricon, java.lang.String text, javax.swing.JComponent comp, java.awt.event.ActionListener listener)` Creates a new `IAction`.
`IBarCodeView`	`newBarCodeView(int[] values, java.awt.Color[] colors, java.awt.Color[] selColors)` Creates a new `IBarCodeView` to be used in `ITable`s as a cell value. The string value will be the properly formatted value.
`IBarCodeView`	`newBarCodeView(int[] values, java.awt.Color[] colors, java.awt.Color[] selColors, java.lang.String stringValue)` Creates a new `IBarCodeView` to be used in `ITable`s as a cell value.
`IBorderPanel`	`newBorderPanel()` Creates a new `IBorderPanel`.
`IBorderPanel`	`newBorderPanel(javax.swing.JComponent centerComp)` Creates a new `IBorderPanel`.
`IBrowser`	`newBrowser()` Creates a new `IBrowser`.
`IPage<? extends IBrowser>`	`newBrowserPage(java.lang.String displayName, IRIcon ricon, IRHtml rhtml)` Creates a new `IPage` which creates `IBrowser` as page component to display the specified HTML resource.
`IButton`	`newButton()` Creates a new `IButton`.
`IButton`	`newButton(IAction action)` Creates a new `IButton`.
`IButton`	`newButton(javax.swing.Icon icon)` Creates a new `IButton`.
`IButton`	`newButton(java.lang.String text)` Creates a new `IButton`.
`IButton`	`newButton(java.lang.String text, javax.swing.Icon icon)` Creates a new `IButton`.
`ICheckBox`	`newCheckBox()` Creates a new `ICheckBox`.
`ICheckBox`	`newCheckBox(java.lang.String text)` Creates a new `ICheckBox`.
`ICheckBox`	`newCheckBox(java.lang.String text, boolean selected)` Creates a new `ICheckBox`.
`ICheckBoxMenuItem`	`newCheckBoxMenuItem()` Creates a new `ICheckBoxMenuItem`.
`ICheckBoxMenuItem`	`newCheckBoxMenuItem(javax.swing.Icon icon)` Creates a new `ICheckBoxMenuItem`.
`ICheckBoxMenuItem`	`newCheckBoxMenuItem(java.lang.String text)` Creates a new `ICheckBoxMenuItem`.
`ICheckBoxMenuItem`	`newCheckBoxMenuItem(java.lang.String text, javax.swing.Icon icon)` Creates a new `ICheckBoxMenuItem`.
`IColorIcon`	`newColorIcon(java.awt.Color color)` Creates a new `IColorIcon`.
`IColorIcon`	`newColorIcon(java.awt.Color color, int width, int height)` Creates a new `IColorIcon`.
`IColorIcon`	`newColorIcon(java.awt.Color color, int width, int height, java.lang.String text)` Creates a new `IColorIcon`.
`IColorIcon`	`newColorIcon(java.awt.Color color, java.lang.String text)` Creates a new `IColorIcon`.
`<E> IComboBox<E>`	`newComboBox()` Creates a new `IComboBox`.
`<E> IComboBox<E>`	`newComboBox(E[] items)` Creates a new `IComboBox`.
`<E> IComboBox<E>`	`newComboBox(java.util.Vector<E> items)` Creates a new `IComboBox`.
`IDialog`	`newDialog(java.awt.Frame owner, java.lang.Runnable closeTask)` Creates a new `IDialog` with the specified parent frame.
`IDialog`	`newDialog(java.lang.Runnable closeTask)` Creates a new `IDialog` whose parent will be the main frame (`IServices.getMainFrame()`).
`IFileChooser`	`newFileChooser()` Creates a new `IFileChooser`.
`IFileChooser`	`newFileChooser(java.nio.file.Path currentFolder)` Creates a new `IFileChooser`.
`IGridBagPanel`	`newGridBagPanel()` Creates a new `IGridBagPanel`.
`IHelpIcon`	`newHelpIcon(IRHtml helpRhtml)` Creates a new `IHelpIcon`.
`IHelpIcon`	`newHelpIcon(IRHtml helpRhtml, boolean stressed)` Creates a new `IHelpIcon`.
`IIndicatorTextArea`	`newIndicatorTextArea()` Creates a new `IIndicatorTextArea`.
`IIndicatorTextArea`	`newIndicatorTextArea(java.lang.String text)` Creates a new `IIndicatorTextArea`.
`IIndicatorTextField`	`newIndicatorTextField()` Creates a new `IIndicatorTextField`.
`IIndicatorTextField`	`newIndicatorTextField(java.lang.String text)` Creates a new `IIndicatorTextField`.
`ILabel`	`newLabel()` Creates a new `ILabel`.
`ILabel`	`newLabel(javax.swing.Icon icon)` Creates a new `ILabel`.
`ILabel`	`newLabel(java.lang.String text)` Creates a new `ILabel`.
`ILabel`	`newLabel(java.lang.String text, javax.swing.Icon icon)` Creates a new `ILabel`.
`ILabel`	`newLabel(java.lang.String text, javax.swing.Icon icon, int halignment)` Creates a new `ILabel`.
`ILabel`	`newLabel(java.lang.String text, int halignment)` Creates a new `ILabel`.
`ILink`	`newLink()` Creates a new `ILink` with no URL and no target action.
`ILink`	`newLink(java.lang.String text)` Creates a new `ILink` with no URL or target action.
`ILink`	`newLink(java.lang.String text, Consumer<java.awt.event.MouseEvent> consumer)` Creates a new `ILink` which forwards mouse click events to the specified `Consumer`.
`ILink`	`newLink(java.lang.String text, java.net.URL url)` Creates a new `ILink` which opens the specified URL in the user's default browser when clicked.
`ILink`	`newLink(java.lang.String text, java.net.URL url, Consumer<java.awt.event.MouseEvent> consumer)` Creates a new `ILink` which forwards mouse click events to the specified `Consumer` and opens the specified URL in the user's default browser when clicked.
`<E> IList<E>`	`newList()` Creates a new `IList`.
`IMenu`	`newMenu()` Creates a new `IMenu`.
`IMenu`	`newMenu(javax.swing.Icon icon)` Creates a new `IMenu`.
`IMenu`	`newMenu(java.lang.String text)` Creates a new `IMenu`.
`IMenu`	`newMenu(java.lang.String text, javax.swing.Icon icon)` Creates a new `IMenu`.
`IMenuItem`	`newMenuItem()` Creates a new `IMenuItem`.
`IMenuItem`	`newMenuItem(javax.swing.Icon icon)` Creates a new `IMenuItem`.
`IMenuItem`	`newMenuItem(java.lang.String text)` Creates a new `IMenuItem`.
`IMenuItem`	`newMenuItem(java.lang.String text, javax.swing.Icon icon)` Creates a new `IMenuItem`.
`IModestLabel`	`newModestLabel()` Creates a new `IModestLabel`.
`IModestLabel`	`newModestLabel(java.lang.String text)` Creates a new `IModestLabel`.
`IMultiPageComp`	`newMultiPageComp(java.util.List<IPage<?>> pageList, IPage<?> defaultPage, javax.swing.JComponent rootComponent)` Creates a new `IMultiPageComp`.
`IOverlayCard`	`newOverlayCard(OverlayCardParams params, IConfigPopupBuilder configPopupBuilder, java.lang.Runnable closeTask)` Creates a new `IDialog` with the specified parent frame.
`<T extends javax.swing.JComponent> IPage<T>`	`newPage(java.lang.String displayName, IRIcon ricon, boolean closeable, IPageCompCreator<T> pageCompCreator)` Creates a new `IPage`.
`IPasswordField`	`newPasswordField()` Creates a new `IPasswordField`.
`IPasswordField`	`newPasswordField(int columns)` Creates a new `IPasswordField`.
`IPasswordField`	`newPasswordField(java.lang.String text)` Creates a new `IPasswordField`.
`IPasswordField`	`newPasswordField(java.lang.String text, int columns)` Creates a new `IPasswordField`.
`IPathField`	`newPathField()` Creates a new `IPathField` in folder mode.
`IPathField`	`newPathField(boolean fileMode)` Creates a new `IPathField` in the specified mode.
`IPathField`	`newPathField(java.nio.file.Path path)` Creates a new `IPathField` in folder mode.
`IPathField`	`newPathField(java.nio.file.Path path, boolean fileMode)` Creates a new `IPathField` in the specified mode.
`IPopupMenu`	`newPopupMenu()` Creates a new `IPopupMenu`.
`IPopupMenu`	`newPopupMenu(ILabel titleLabel)` Creates a new `IPopupMenu`.
`IPopupMenu`	`newPopupMenu(java.lang.String text)` Creates a new `IPopupMenu`.
`IPopupMenu`	`newPopupMenu(java.lang.String text, javax.swing.Icon icon)` Creates a new `IPopupMenu`.
`IProgressBar`	`newProgressBar()` Creates a new `IProgressBar`.
`IProgressBarView`	`newProgressBarView(int value, int maximum)` Creates a new `IProgressBarView` to be used in `ITable`s as a cell value. The string value will be the properly formatted value.
`IProgressBarView`	`newProgressBarView(int value, int maximum, java.lang.String stringValue)` Creates a new `IProgressBarView` to be used in `ITable`s as a cell value.
`<T> IRenderablePair<T>`	`newRenderablePair(javax.swing.Icon icon, T textProvider)` Creates a new IMMUTABLE `IRenderablePair`.
`IRHtml`	`newRHtml(java.lang.String title, java.net.URL resource, java.util.Set<java.lang.String> htmlParams, java.lang.String... params)` Creates a new `IRHtml`.
`IRHtml`	`newRHtml(java.lang.String title, java.net.URL resource, java.lang.String... params)` Creates a new `IRHtml`.
`IRIcon`	`newRIcon(java.net.URL url)` Creates a new `IRIcon` from the specified image location.
`IScrollPane`	`newScrollPane()` Creates a new `IScrollPane` with small preferred size.
`IScrollPane`	`newScrollPane(java.awt.Component view)` Creates a new `IScrollPane` with small preferred size.
`IScrollPane`	`newScrollPane(java.awt.Component view, boolean smallSize)` Creates a new `IScrollPane`.
`IScrollPane`	`newScrollPane(java.awt.Component view, boolean smallSize, boolean followScrollingSetting)` Creates a new `IScrollPane`.
`ISpinner`	`newSpinner()` Creates a new `ISpinner` with an `Integer` `SpinnerNumberModel` with initial value 0 and no minimum or maximum limits.
`ISpinner`	`newSpinner(javax.swing.SpinnerModel model)` Creates a new `ISpinner`.
`ISplitPane`	`newSplitPane()` Creates a new `ISplitPane` using `JSplitPane.HORIZONTAL_SPLIT` orientation (the splitter will be vertical).
`ISplitPane`	`newSplitPane(int orientation)` Creates a new `ISplitPane`.
`IStatusLabel`	`newStatusLabel()` Creates a new `IStatusLabel`.
`IStatusLabel`	`newStatusLabel(IStatusLabel.IStatusType type, java.lang.String message)` Creates a new `IStatusLabel`.
`ITabbedPane`	`newTabbedPane()` Creates a new `ITabbedPane`.
`ITable`	`newTable()` Creates a new `ITable`.
`ITemplateField`	`newTemplateField()` Creates a new `ITemplateField` with a template editor dialog opener button added.
`ITemplateField`	`newTemplateField(boolean addDialogOpener)` Creates a new `ITemplateField`.
`ITemplateField`	`newTemplateField(java.lang.String template)` Creates a new `ITemplateField` with a template editor dialog opener button added.
`ITemplateField`	`newTemplateField(java.lang.String template, boolean addDialogOpener)` Creates a new `ITemplateField`.
`ITextArea`	`newTextArea()` Creates a new `ITextArea`.
`ITextArea`	`newTextArea(java.lang.String text)` Creates a new `ITextArea`.
`ITextArea`	`newTextArea(java.lang.String text, int rows, int columns)` Creates a new `ITextArea`.
`ITextField`	`newTextField()` Creates a new `ITextField`.
`ITextField`	`newTextField(boolean clearByEsc)` Creates a new `ITextField`.
`ITextField`	`newTextField(int columns)` Creates a new `ITextField`.
`ITextField`	`newTextField(java.lang.String text)` Creates a new `ITextField`.
`ITextField`	`newTextField(java.lang.String text, int columns)` Creates a new `ITextField`.
`ITextField`	`newTextField(java.lang.String text, int columns, boolean clearByEsc)` Creates a new `ITextField`.
`ITipIcon`	`newTipIcon(IRHtml tipRhtml)` Creates a new `ITipIcon`.
`IToolBar`	`newToolBar()` Creates a new `IToolBar`.
`IToolBar`	`newToolBar(boolean initialSpace)` Creates a new `IToolBar`.
`IToolBarForList`	`newToolBarForList(IList<?> list)` Creates a new `IToolBarForList`.
`IToolBarForTable`	`newToolBarForTable(ITable table)` Creates a new `IToolBarForTable`.
`IToolBarForTree`	`newToolBarForTree(ITree tree)` Creates a new `IToolBarForTree`.
`ITree`	`newTree(javax.swing.tree.TreeNode root)` Creates a new `ITree`.

- Method Detail
  - newLabel
```
ILabel newLabel()
```
    Creates a new ILabel.
    
    Returns:
    a new ILabel
  - newLabel
```
ILabel newLabel(java.lang.String text)
```
    Creates a new ILabel.
    
    Parameters:
    text - text of the label
    
    Returns:
    a new ILabel
  - newLabel
```
ILabel newLabel(java.lang.String text,
              int halignment)
```
    Creates a new ILabel.
    
    Parameters:
    text - text of the label
    halignment - horizontal alignment; one of SwingConstants: LEFT, CENTER, RIGHT, LEADING or TRAILING
    
    Returns:
    a new ILabel
  - newLabel
```
ILabel newLabel(javax.swing.Icon icon)
```
    Creates a new ILabel.
    
    Parameters:
    icon - icon of the label
    
    Returns:
    a new ILabel
  - newLabel
```
ILabel newLabel(java.lang.String text,
              javax.swing.Icon icon)
```
    Creates a new ILabel.
    
    Parameters:
    text - text of the label
    icon - icon of the label
    
    Returns:
    a new ILabel
  - newLabel
```
ILabel newLabel(java.lang.String text,
              javax.swing.Icon icon,
              int halignment)
```
    Creates a new ILabel.
    
    Parameters:
    text - text of the label
    icon - icon of the label
    halignment - horizontal alignment; one of SwingConstants: LEFT, CENTER, RIGHT, LEADING or TRAILING
    
    Returns:
    a new ILabel
  - newRIcon
```
IRIcon newRIcon(java.net.URL url)
```
    Creates a new IRIcon from the specified image location.
    Created and returned IRIcons should always be cached for performance reasons, that way the image resource represented by the IRIcon can be shared and reused.
    
    Supported image formats include PNG, JPEG, GIF.
    
    Parameters:
    url - the URL for the image to create an IRIcon from
    
    Returns:
    a new IRIcon
    See Also:
    IRIcon
  - newRHtml
```
IRHtml newRHtml(java.lang.String title,
              java.net.URL resource,
              java.lang.String... params)
```
    Creates a new IRHtml.
    
    Parameters:
    title - title of the HTML template
    resource - HTML template resource
    params - param name - param value pairs to be substituted in the HTML template;
    param names must be in raw format, they will be prepended with "${" and postpended with "}"
    
    Returns:
    a new IRHtml
    See Also:
    IRHtml
  - newRHtml
```
IRHtml newRHtml(java.lang.String title,
              java.net.URL resource,
              java.util.Set<java.lang.String> htmlParams,
              java.lang.String... params)
```
    Creates a new IRHtml.
    
    Parameters:
    title - title of the HTML template
    resource - HTML template resource
    htmlParams - collection of HTML param names, values of these parameters are treated as HTML and are not escaped
    params - param name - param value pairs to be substituted in the HTML template;
    param names must be in raw format, they will be prepended with "${" and postpended with "}"
    
    Returns:
    a new IRHtml
    See Also:
    IRHtml
  - newHelpIcon
```
IHelpIcon newHelpIcon(IRHtml helpRhtml)
```
    Creates a new IHelpIcon.
    
    Parameters:
    helpRhtml - html template resource of the help content
    
    Returns:
    a new IHelpIcon
  - newHelpIcon
```
IHelpIcon newHelpIcon(IRHtml helpRhtml,
                    boolean stressed)
```
    Creates a new IHelpIcon.
    
    Parameters:
    helpRhtml - html template resource of the help content
    stressed - tells if the help icon's appearance should be garish, stressed
    
    Returns:
    a new IHelpIcon
  - newTipIcon
```
ITipIcon newTipIcon(IRHtml tipRhtml)
```
    Creates a new ITipIcon.
    
    Parameters:
    tipRhtml - html template resource of the tip content
    
    Returns:
    a new ITipIcon
  - newLink
```
ILink newLink()
```
    Creates a new ILink with no URL and no target action.
    
    Returns:
    a new ILink
  - newLink
```
ILink newLink(java.lang.String text)
```
    Creates a new ILink with no URL or target action.
    Basically this is a link-styled ILabel.
    
    Parameters:
    text - text of the link
    
    Returns:
    a new ILink
  - newLink
```
ILink newLink(java.lang.String text,
            java.net.URL url)
```
    Creates a new ILink which opens the specified URL in the user's default browser when clicked.
    
    Parameters:
    text - text of the link
    url - URL to be opened when clicked
    
    Returns:
    a new ILink
  - newLink
```
ILink newLink(java.lang.String text,
            Consumer<java.awt.event.MouseEvent> consumer)
```
    Creates a new ILink which forwards mouse click events to the specified Consumer.
    
    Parameters:
    text - text of the link
    consumer - consumer to be called when clicked
    
    Returns:
    a new ILink
  - newLink
```
ILink newLink(java.lang.String text,
            java.net.URL url,
            Consumer<java.awt.event.MouseEvent> consumer)
```
    Creates a new ILink which forwards mouse click events to the specified Consumer and opens the specified URL in the user's default browser when clicked.
    
    Parameters:
    text - text of the link
    url - URL to be opened when clicked
    consumer - consumer to be called when clicked
    
    Returns:
    a new ILink
  - newAction
```
IAction newAction(IRIcon ricon,
                java.lang.String text,
                java.awt.event.ActionListener listener)
```
    Creates a new IAction.
    
    Parameters:
    ricon - optional ricon of the action
    text - text of the action
    listener - action listener to be called when action is performed
    
    Returns:
    a new IAction
  - newAction
```
IAction newAction(IRIcon ricon,
                java.lang.String text,
                javax.swing.JComponent comp,
                java.awt.event.ActionListener listener)
```
    Creates a new IAction.
    
    Parameters:
    ricon - optional ricon of the action
    text - text of the action
    comp - component to bind the action's setting change listener to; basically in this case the lifetime of the scl will be bound to the specified component's lifetime
    listener - action listener to be called when action is performed
    
    Returns:
    a new IAction
  - newAction
```
IAction newAction(javax.swing.KeyStroke keyStroke,
                IRIcon ricon,
                java.lang.String text,
                java.awt.event.ActionListener listener)
```
    Creates a new IAction.
    
    Parameters:
    keyStroke - optional hotkey of the action
    ricon - optional ricon of the action
    text - text of the action
    listener - action listener to be called when action is performed
    
    Returns:
    a new IAction
  - newAction
```
IAction newAction(javax.swing.KeyStroke keyStroke,
                IRIcon ricon,
                java.lang.String text,
                javax.swing.JComponent comp,
                java.awt.event.ActionListener listener)
```
    Creates a new IAction.
    
    Parameters:
    keyStroke - optional hotkey of the action
    ricon - optional ricon of the action
    text - text of the action
    comp - component to bind the action's setting change listener to; basically in this case the lifetime of the scl will be bound to the specified component's lifetime
    listener - action listener to be called when action is performed
    
    Returns:
    a new IAction
  - newButton
```
IButton newButton()
```
    Creates a new IButton.
    
    Returns:
    a new IButton
  - newButton
```
IButton newButton(java.lang.String text)
```
    Creates a new IButton.
    
    Parameters:
    text - text of the button
    
    Returns:
    a new IButton
  - newButton
```
IButton newButton(javax.swing.Icon icon)
```
    Creates a new IButton.
    
    Parameters:
    icon - icon of the button
    
    Returns:
    a new IButton
  - newButton
```
IButton newButton(java.lang.String text,
                javax.swing.Icon icon)
```
    Creates a new IButton.
    
    Parameters:
    text - text of the button
    icon - icon of the button
    
    Returns:
    a new IButton
  - newButton
```
IButton newButton(IAction action)
```
    Creates a new IButton.
    
    Parameters:
    action - action to configure the button from
    
    Returns:
    a new IButton
  - newTextField
```
ITextField newTextField()
```
    Creates a new ITextField.
    
    Returns:
    a new ITextField
  - newTextField
```
ITextField newTextField(boolean clearByEsc)
```
    Creates a new ITextField.
    
    Parameters:
    clearByEsc - tells if text field should be cleared when the ESC key is pressed
    
    Returns:
    a new ITextField
  - newTextField
```
ITextField newTextField(java.lang.String text)
```
    Creates a new ITextField.
    
    Parameters:
    text - initial text of the text field
    
    Returns:
    a new ITextField
  - newTextField
```
ITextField newTextField(int columns)
```
    Creates a new ITextField.
    
    Parameters:
    columns - the number of columns to use to calculate the preferred width; if columns is set to zero, the preferred width will be whatever naturally results from the component implementation
    
    Returns:
    a new ITextField
  - newTextField
```
ITextField newTextField(java.lang.String text,
                      int columns)
```
    Creates a new ITextField.
    
    Parameters:
    text - text of the check box
    columns - the number of columns to use to calculate the preferred width; if columns is set to zero, the preferred width will be whatever naturally results from the component implementation
    
    Returns:
    a new ITextField
  - newTextField
```
ITextField newTextField(java.lang.String text,
                      int columns,
                      boolean clearByEsc)
```
    Creates a new ITextField.
    
    Parameters:
    text - text of the check box
    columns - the number of columns to use to calculate the preferred width; if columns is set to zero, the preferred width will be whatever naturally results from the component implementation
    clearByEsc - tells if text field should be cleared when the ESC key is pressed
    
    Returns:
    a new ITextField
  - newIndicatorTextField
```
IIndicatorTextField newIndicatorTextField()
```
    Creates a new IIndicatorTextField.
    
    Returns:
    a new IIndicatorTextField
  - newIndicatorTextField
```
IIndicatorTextField newIndicatorTextField(java.lang.String text)
```
    Creates a new IIndicatorTextField.
    
    Parameters:
    text - initial text to be set
    
    Returns:
    a new IIndicatorTextField
  - newTextArea
```
ITextArea newTextArea()
```
    Creates a new ITextArea.
    
    Returns:
    a new ITextArea
  - newTextArea
```
ITextArea newTextArea(java.lang.String text)
```
    Creates a new ITextArea.
    
    Parameters:
    text - initial text of the text area
    
    Returns:
    a new ITextArea
  - newTextArea
```
ITextArea newTextArea(java.lang.String text,
                    int rows,
                    int columns)
```
    Creates a new ITextArea.
    
    Parameters:
    text - initial text of the text area
    rows - the number of rows to use to calculate the preferred height
    columns - the number of columns to use to calculate the preferred width
    
    Returns:
    a new ITextArea
  - newIndicatorTextArea
```
IIndicatorTextArea newIndicatorTextArea()
```
    Creates a new IIndicatorTextArea.
    
    Returns:
    a new IIndicatorTextArea
    Since:
    
    1.4
  - newIndicatorTextArea
```
IIndicatorTextArea newIndicatorTextArea(java.lang.String text)
```
    Creates a new IIndicatorTextArea.
    
    Parameters:
    text - initial text to be set
    
    Returns:
    a new IIndicatorTextArea
    Since:
    
    1.4
  - newBorderPanel
```
IBorderPanel newBorderPanel()
```
    Creates a new IBorderPanel.
    
    Returns:
    a new IBorderPanel
  - newBorderPanel
```
IBorderPanel newBorderPanel(javax.swing.JComponent centerComp)
```
    Creates a new IBorderPanel.
    
    Parameters:
    centerComp - component to be added to the center
    
    Returns:
    a new IBorderPanel
  - newBrowser
```
IBrowser newBrowser()
```
    Creates a new IBrowser.
    
    Returns:
    a new IBrowser
  - newColorIcon
```
IColorIcon newColorIcon(java.awt.Color color)
```
    Creates a new IColorIcon.
    
    Parameters:
    color - color of the icon.
    
    Returns:
    a new IColorIcon
  - newColorIcon
```
IColorIcon newColorIcon(java.awt.Color color,
                      java.lang.String text)
```
    Creates a new IColorIcon.
    
    Parameters:
    color - color of the icon.
    text - text to be returned by the IColorIcon.toString() method
    
    Returns:
    a new IColorIcon
  - newColorIcon
```
IColorIcon newColorIcon(java.awt.Color color,
                      int width,
                      int height)
```
    Creates a new IColorIcon.
    
    Parameters:
    color - color of the icon.
    width - width of the icon
    height - height of the icon
    
    Returns:
    a new IColorIcon
  - newColorIcon
```
IColorIcon newColorIcon(java.awt.Color color,
                      int width,
                      int height,
                      java.lang.String text)
```
    Creates a new IColorIcon.
    
    Parameters:
    color - color of the icon.
    width - width of the icon
    height - height of the icon
    text - text to be returned by the IColorIcon.toString() method
    
    Returns:
    a new IColorIcon
  - newGridBagPanel
```
IGridBagPanel newGridBagPanel()
```
    Creates a new IGridBagPanel.
    
    Returns:
    a new IGridBagPanel
  - newModestLabel
```
IModestLabel newModestLabel()
```
    Creates a new IModestLabel.
    
    Returns:
    a new IModestLabel
  - newModestLabel
```
IModestLabel newModestLabel(java.lang.String text)
```
    Creates a new IModestLabel.
    
    Parameters:
    text - text of the label
    
    Returns:
    a new IModestLabel
  - newFileChooser
```
IFileChooser newFileChooser()
```
    Creates a new IFileChooser.
    
    Returns:
    a new IFileChooser
  - newFileChooser
```
IFileChooser newFileChooser(java.nio.file.Path currentFolder)
```
    Creates a new IFileChooser.
    
    Parameters:
    currentFolder - default folder to navigate to
    
    Returns:
    a new IFileChooser
  - newPathField
```
IPathField newPathField()
```
    Creates a new IPathField in folder mode.
    
    Returns:
    a new IPathField
  - newPathField
```
IPathField newPathField(boolean fileMode)
```
    Creates a new IPathField in the specified mode.
    
    Parameters:
    fileMode - if true, the field operates as a file chooser; else as a folder chooser
    
    Returns:
    a new IPathField
  - newPathField
```
IPathField newPathField(java.nio.file.Path path)
```
    Creates a new IPathField in folder mode.
    
    Parameters:
    path - initial path to be set
    
    Returns:
    a new IPathField
  - newPathField
```
IPathField newPathField(java.nio.file.Path path,
                      boolean fileMode)
```
    Creates a new IPathField in the specified mode.
    
    Parameters:
    path - initial path to be set
    fileMode - if true, the field operates as a file chooser; else as a folder chooser
    
    Returns:
    a new IPathField
  - newStatusLabel
```
IStatusLabel newStatusLabel()
```
    Creates a new IStatusLabel.
    
    Returns:
    a new IStatusLabel
  - newStatusLabel
```
IStatusLabel newStatusLabel(IStatusLabel.IStatusType type,
                          java.lang.String message)
```
    Creates a new IStatusLabel.
    
    Parameters:
    type - initial status type to be set
    message - initial status message to be set
    
    Returns:
    a new IStatusLabel
  - newCheckBox
```
ICheckBox newCheckBox()
```
    Creates a new ICheckBox.
    
    Returns:
    a new ICheckBox
  - newCheckBox
```
ICheckBox newCheckBox(java.lang.String text)
```
    Creates a new ICheckBox.
    
    Parameters:
    text - text of the check box
    
    Returns:
    a new ICheckBox
  - newCheckBox
```
ICheckBox newCheckBox(java.lang.String text,
                    boolean selected)
```
    Creates a new ICheckBox.
    
    Parameters:
    text - text of the check box
    selected - initial selected state
    
    Returns:
    a new ICheckBox
  - newProgressBar
```
IProgressBar newProgressBar()
```
    Creates a new IProgressBar.
    
    Returns:
    a new IProgressBar
  - newScrollPane
```
IScrollPane newScrollPane()
```
    Creates a new IScrollPane with small preferred size.
    
    Returns:
    a new IScrollPane
  - newScrollPane
```
IScrollPane newScrollPane(java.awt.Component view)
```
    Creates a new IScrollPane with small preferred size.
    
    Parameters:
    view - the component to be scrolled
    
    Returns:
    a new IScrollPane
  - newScrollPane
```
IScrollPane newScrollPane(java.awt.Component view,
                        boolean smallSize)
```
    Creates a new IScrollPane.
    
    Parameters:
    view - the component to be scrolled
    smallSize - tells if small preferred size is to be set to prefer vertical scrolling instead of horizontal
    
    Returns:
    a new IScrollPane
  - newScrollPane
```
IScrollPane newScrollPane(java.awt.Component view,
                        boolean smallSize,
                        boolean followScrollingSetting)
```
    Creates a new IScrollPane.
    
    Parameters:
    view - the component to be scrolled
    smallSize - tells if small preferred size is to be set to prefer vertical scrolling instead of horizontal
    followScrollingSetting - tells if the vertical scrolling amount setting is to be followed
    
    Returns:
    a new IScrollPane
  - newSpinner
```
ISpinner newSpinner()
```
    Creates a new ISpinner with an Integer SpinnerNumberModel with initial value 0 and no minimum or maximum limits.
    
    Returns:
    a new ISpinner
  - newSpinner
```
ISpinner newSpinner(javax.swing.SpinnerModel model)
```
    Creates a new ISpinner.
    
    Parameters:
    model - model to create the spinner with
    
    Returns:
    a new ISpinner
  - newSplitPane
```
ISplitPane newSplitPane()
```
    Creates a new ISplitPane using JSplitPane.HORIZONTAL_SPLIT orientation (the splitter will be vertical).
    
    Returns:
    a new ISplitPane
  - newSplitPane
```
ISplitPane newSplitPane(int orientation)
```
    Creates a new ISplitPane.
    
    Parameters:
    orientation - orientation (JSplitPane.HORIZONTAL_SPLIT or JSplitPane.VERTICAL_SPLIT)
    
    Returns:
    a new ISplitPane
  - newToolBar
```
IToolBar newToolBar()
```
    Creates a new IToolBar.
    
    Returns:
    a new IToolBar
  - newToolBar
```
IToolBar newToolBar(boolean initialSpace)
```
    Creates a new IToolBar.
    
    Parameters:
    initialSpace - tells if initial space component is to be added
    
    Returns:
    a new IToolBar
  - newComboBox
```
<E> IComboBox<E> newComboBox()
```
    Creates a new IComboBox.
    
    Type Parameters:
    E - type of the elements added to the combo box
    
    Returns:
    a new IComboBox
  - newComboBox
```
<E> IComboBox<E> newComboBox(E[] items)
```
    Creates a new IComboBox.
    
    Type Parameters:
    E - type of the elements added to the combo box
    Parameters:
    items - initial items to be added to the combo box
    
    Returns:
    a new IComboBox
  - newComboBox
```
<E> IComboBox<E> newComboBox(java.util.Vector<E> items)
```
    Creates a new IComboBox.
    
    Type Parameters:
    E - type of the elements added to the combo box
    Parameters:
    items - initial items to be added to the combo box
    
    Returns:
    a new IComboBox
  - newTable
```
ITable newTable()
```
    Creates a new ITable.
    
    Returns:
    a new ITable
  - newProgressBarView
```
IProgressBarView newProgressBarView(int value,
                                  int maximum)
```
    Creates a new IProgressBarView to be used in ITables as a cell value.
    The string value will be the properly formatted value.
    
    Parameters:
    value - value for the progress bar
    maximum - maximum value for the progress bar
    
    Returns:
    a new IProgressBarView
    Since:
    
    1.2
    
    See Also:
    newProgressBarView(int, int, String), IProgressBarView
  - newProgressBarView
```
IProgressBarView newProgressBarView(int value,
                                  int maximum,
                                  java.lang.String stringValue)
```
    Creates a new IProgressBarView to be used in ITables as a cell value.
    
    Parameters:
    value - value for the progress bar
    maximum - maximum value for the progress bar
    stringValue - string value to be displayed
    
    Returns:
    a new IProgressBarView
    Since:
    
    1.2
    
    See Also:
    newProgressBarView(int, int), IProgressBarView
  - newBarCodeView
```
IBarCodeView newBarCodeView(int[] values,
                          java.awt.Color[] colors,
                          java.awt.Color[] selColors)
```
    Creates a new IBarCodeView to be used in ITables as a cell value.
    The string value will be the properly formatted value.
    
    Parameters:
    values - values of the parts of the bar code
    colors - colors of the parts of the bar code
    selColors - colors of the parts of the bar code when the cell is selected
    
    Returns:
    a new IBarCodeView
    
    Throws:
    
    java.lang.IllegalArgumentException - if the number of values, colors and selected colors are not the same
    Since:
    
    1.2
    
    See Also:
    newBarCodeView(int[], Color[], Color[], String), IBarCodeView
  - newBarCodeView
```
IBarCodeView newBarCodeView(int[] values,
                          java.awt.Color[] colors,
                          java.awt.Color[] selColors,
                          java.lang.String stringValue)
```
    Creates a new IBarCodeView to be used in ITables as a cell value.
    
    Parameters:
    values - values of the parts of the bar code
    colors - colors of the parts of the bar code
    selColors - colors of the parts of the bar code when the cell is selected
    stringValue - string value to be displayed
    
    Returns:
    a new IBarCodeView
    
    Throws:
    
    java.lang.IllegalArgumentException - if the number of values, colors and selected colors are not the same
    Since:
    
    1.2
    
    See Also:
    newBarCodeView(int[], Color[], Color[]), IBarCodeView
  - newToolBarForTable
```
IToolBarForTable newToolBarForTable(ITable table)
```
    Creates a new IToolBarForTable.
    
    Parameters:
    table - targeted table whose selection changes to listen
    
    Returns:
    a new IToolBarForTable
  - newList
```
<E> IList<E> newList()
```
    Creates a new IList.
    
    Type Parameters:
    E - type of the elements in the list
    
    Returns:
    a new IList
  - newToolBarForList
```
IToolBarForList newToolBarForList(IList<?> list)
```
    Creates a new IToolBarForList.
    
    Parameters:
    list - targeted list whose selection changes to listen
    
    Returns:
    a new IToolBarForList
  - newTree
```
ITree newTree(javax.swing.tree.TreeNode root)
```
    Creates a new ITree.
    
    Parameters:
    root - root node
    
    Returns:
    a new ITree
  - newToolBarForTree
```
IToolBarForTree newToolBarForTree(ITree tree)
```
    Creates a new IToolBarForTree.
    
    Parameters:
    tree - targeted tree whose selection changes to listen
    
    Returns:
    a new IToolBarForTree
  - newMenu
```
IMenu newMenu()
```
    Creates a new IMenu.
    
    Returns:
    a new IMenu
  - newMenu
```
IMenu newMenu(java.lang.String text)
```
    Creates a new IMenu.
    
    Parameters:
    text - text of the menu
    
    Returns:
    a new IMenu
  - newMenu
```
IMenu newMenu(javax.swing.Icon icon)
```
    Creates a new IMenu.
    
    Parameters:
    icon - icon of the menu
    
    Returns:
    a new IMenu
  - newMenu
```
IMenu newMenu(java.lang.String text,
            javax.swing.Icon icon)
```
    Creates a new IMenu.
    
    Parameters:
    text - text of the menu
    icon - icon of the menu
    
    Returns:
    a new IMenu
  - newMenuItem
```
IMenuItem newMenuItem()
```
    Creates a new IMenuItem.
    
    Returns:
    a new IMenuItem
  - newMenuItem
```
IMenuItem newMenuItem(java.lang.String text)
```
    Creates a new IMenuItem.
    
    Parameters:
    text - text of the menu item
    
    Returns:
    a new IMenuItem
  - newMenuItem
```
IMenuItem newMenuItem(javax.swing.Icon icon)
```
    Creates a new IMenuItem.
    
    Parameters:
    icon - icon of the menu item
    
    Returns:
    a new IMenuItem
  - newMenuItem
```
IMenuItem newMenuItem(java.lang.String text,
                    javax.swing.Icon icon)
```
    Creates a new IMenuItem.
    
    Parameters:
    text - text of the menu item
    icon - icon of the menu item
    
    Returns:
    a new IMenuItem
  - newCheckBoxMenuItem
```
ICheckBoxMenuItem newCheckBoxMenuItem()
```
    Creates a new ICheckBoxMenuItem.
    
    Returns:
    a new ICheckBoxMenuItem
  - newCheckBoxMenuItem
```
ICheckBoxMenuItem newCheckBoxMenuItem(java.lang.String text)
```
    Creates a new ICheckBoxMenuItem.
    
    Parameters:
    text - text of the check box menu item
    
    Returns:
    a new ICheckBoxMenuItem
  - newCheckBoxMenuItem
```
ICheckBoxMenuItem newCheckBoxMenuItem(javax.swing.Icon icon)
```
    Creates a new ICheckBoxMenuItem.
    
    Parameters:
    icon - icon of the check box menu item
    
    Returns:
    a new ICheckBoxMenuItem
  - newCheckBoxMenuItem
```
ICheckBoxMenuItem newCheckBoxMenuItem(java.lang.String text,
                                    javax.swing.Icon icon)
```
    Creates a new ICheckBoxMenuItem.
    
    Parameters:
    text - text of the check box menu item
    icon - icon of the check box menu item
    
    Returns:
    a new ICheckBoxMenuItem
  - newPasswordField
```
IPasswordField newPasswordField()
```
    Creates a new IPasswordField.
    
    Returns:
    a new IPasswordField
  - newPasswordField
```
IPasswordField newPasswordField(java.lang.String text)
```
    Creates a new IPasswordField.
    
    Parameters:
    text - initial text of the password field
    
    Returns:
    a new IPasswordField
  - newPasswordField
```
IPasswordField newPasswordField(int columns)
```
    Creates a new IPasswordField.
    
    Parameters:
    columns - the number of columns to use to calculate the preferred width; if columns is set to zero, the preferred width will be whatever naturally results from the component implementation
    
    Returns:
    a new IPasswordField
  - newPasswordField
```
IPasswordField newPasswordField(java.lang.String text,
                              int columns)
```
    Creates a new IPasswordField.
    
    Parameters:
    text - initial text of the password field
    columns - the number of columns to use to calculate the preferred width; if columns is set to zero, the preferred width will be whatever naturally results from the component implementation
    
    Returns:
    a new IPasswordField
  - newPopupMenu
```
IPopupMenu newPopupMenu()
```
    Creates a new IPopupMenu.
    
    Returns:
    a new IPopupMenu
  - newPopupMenu
```
IPopupMenu newPopupMenu(java.lang.String text)
```
    Creates a new IPopupMenu.
    
    Parameters:
    text - text of the popup title
    
    Returns:
    a new IPopupMenu
  - newPopupMenu
```
IPopupMenu newPopupMenu(java.lang.String text,
                      javax.swing.Icon icon)
```
    Creates a new IPopupMenu.
    
    Parameters:
    text - text of the popup title
    icon - icon of the popup title
    
    Returns:
    a new IPopupMenu
  - newPopupMenu
```
IPopupMenu newPopupMenu(ILabel titleLabel)
```
    Creates a new IPopupMenu.
    
    Parameters:
    titleLabel - title label of the popup
    
    Returns:
    a new IPopupMenu
  - newTabbedPane
```
ITabbedPane newTabbedPane()
```
    Creates a new ITabbedPane.
    
    Returns:
    a new ITabbedPane
  - newPage
```
<T extends javax.swing.JComponent> IPage<T> newPage(java.lang.String displayName,
                                                  IRIcon ricon,
                                                  boolean closeable,
                                                  IPageCompCreator<T> pageCompCreator)
```
    Creates a new IPage.
    
    Type Parameters:
    T - type of the page component
    Parameters:
    displayName - display name of the page
    ricon - ricon of the page
    closeable - tells if the page is closeable
    pageCompCreator - page component creator
    
    Returns:
    a new IPage
    See Also:
    IPage, IPageCompCreator
  - newBrowserPage
```
IPage<? extends IBrowser> newBrowserPage(java.lang.String displayName,
                                       IRIcon ricon,
                                       IRHtml rhtml)
```
    Creates a new IPage which creates IBrowser as page component to display the specified HTML resource.
    
    Parameters:
    displayName - display name of the page
    ricon - icon resource of the page
    rhtml - HTML template resource to display as content
    
    Returns:
    a new IPage
  - newMultiPageComp
```
IMultiPageComp newMultiPageComp(java.util.List<IPage<?>> pageList,
                              IPage<?> defaultPage,
                              javax.swing.JComponent rootComponent)
```
    Creates a new IMultiPageComp.
    
    Parameters:
    pageList - initial page list to be set
    defaultPage - optional page to select by default; if null, the first page will be selected
    rootComponent - root component to register key strokes at
    
    Returns:
    a new IMultiPageComp
    See Also:
    IMultiPageComp, newPage(String, IRIcon, boolean, IPageCompCreator)
  - newTemplateField
```
ITemplateField newTemplateField()
```
    Creates a new ITemplateField with a template editor dialog opener button added.
    
    Returns:
    a new ITemplateField
  - newTemplateField
```
ITemplateField newTemplateField(java.lang.String template)
```
    Creates a new ITemplateField with a template editor dialog opener button added.
    
    Parameters:
    template - initial template to be set
    
    Returns:
    a new ITemplateField
  - newTemplateField
```
ITemplateField newTemplateField(boolean addDialogOpener)
```
    Creates a new ITemplateField.
    
    Parameters:
    addDialogOpener - tells if a template editor dialog opener button is to be added
    
    Returns:
    a new ITemplateField
  - newTemplateField
```
ITemplateField newTemplateField(java.lang.String template,
                              boolean addDialogOpener)
```
    Creates a new ITemplateField.
    
    Parameters:
    template - initial template to be set
    addDialogOpener - tells if a template editor dialog opener button is to be added
    
    Returns:
    a new ITemplateField
  - newDialog
```
IDialog newDialog(java.lang.Runnable closeTask)
```
    Creates a new IDialog whose parent will be the main frame (IServices.getMainFrame()).
    The returned dialog is not yet made visible.
    
    Parameters:
    closeTask - optional close task to be run right before the dialog is closed
    
    Returns:
    a new IDialog
    See Also:
    IDialog
  - newDialog
```
IDialog newDialog(java.awt.Frame owner,
                java.lang.Runnable closeTask)
```
    Creates a new IDialog with the specified parent frame.
    The returned dialog is not yet made visible.
    
    Parameters:
    owner - reference to the owner frame
    closeTask - optional close task to be run right before the dialog is closed
    
    Returns:
    a new IDialog
    See Also:
    IDialog
  - newOverlayCard
```
IOverlayCard newOverlayCard(OverlayCardParams params,
                          IConfigPopupBuilder configPopupBuilder,
                          java.lang.Runnable closeTask)
```
    Creates a new IDialog with the specified parent frame.
    The returned overlay card is not yet made visible.
    
    Parameters:
    params - overlay card parameters wrapper
    configPopupBuilder - optional config popup builder, can be used to add custom items to the config popup (before it is displayed)
    closeTask - optional close task to be run right before the overlay card is closed
    
    Returns:
    a new IDialog
    See Also:
    IDialog, OverlayCardParams, IConfigPopupBuilder
  - newRenderablePair
```
<T> IRenderablePair<T> newRenderablePair(javax.swing.Icon icon,
                                       T textProvider)
```
    Creates a new IMMUTABLE IRenderablePair.
    
    Type Parameters:
    T - type of the object providing the displayed text
    Parameters:
    icon - icon to be rendered
    textProvider - object providing the displayable text (acquired by Object.toString())
    
    Returns:
    a new IRenderablePair
    See Also:
    IRenderablePair

This API documentation is public and is intended for / allowed to be used by anyone.
Scelight home page: https://sites.google.com/site/scelight/
Scelight is a trademark of András Belicza. Copyright © András Belicza, 2013-2015. All rights reserved.

Interface IGuiFactory

Method Summary

Method Detail

newLabel

newLabel

newLabel

newLabel

newLabel

newLabel

newRIcon

newRHtml

newRHtml

newHelpIcon

newHelpIcon

newTipIcon

newLink

newLink

newLink

newLink

newLink

newAction

newAction

newAction

newAction

newButton

newButton

newButton

newButton

newButton

newTextField

newTextField

newTextField

newTextField

newTextField

newTextField

newIndicatorTextField

newIndicatorTextField

newTextArea

newTextArea

newTextArea

newIndicatorTextArea

newIndicatorTextArea

newBorderPanel

newBorderPanel

newBrowser

newColorIcon

newColorIcon

newColorIcon

newColorIcon

newGridBagPanel

newModestLabel

newModestLabel

newFileChooser

newFileChooser

newPathField

newPathField

newPathField

newPathField

newStatusLabel

newStatusLabel

newCheckBox

newCheckBox

newCheckBox

newProgressBar

newScrollPane

newScrollPane

newScrollPane

newScrollPane

newSpinner

newSpinner

newSplitPane

newSplitPane

newToolBar

newToolBar

newComboBox

newComboBox

newComboBox

newTable

newProgressBarView

newProgressBarView