Package pamViewFX.fxNodes

Class TitledSettingPane<T>

java.lang.Object
PamController.SettingsPane<T>
pamViewFX.fxNodes.TitledSettingPane<T>
Type Parameters:
T - Parameter object type
public class TitledSettingPane<T> extends SettingsPane<T>
Simple decorator class to add a titled border to any settings pane.
Author:
Douglas Gillespie

  • Constructor Details

    • TitledSettingPane

      public TitledSettingPane(SettingsPane<T> settingsPane, String borderTitle)
      Construct a titled settings pane based on an existing pane with the given title.
      Parameters:
      settingsPane - Settings pane
      borderTitle - border title

    • TitledSettingPane

      public TitledSettingPane(SettingsPane<T> settingsPane)
      Construct a titled settings pane based on an existing pane using the panes name as the title.
      Parameters:
      settingsPane - Settings pane

  • Method Details

    • getParams

      public T getParams(T currParams)
      Description copied from class: SettingsPane
      Get settings from the pane.
      Specified by:
      getParams in class SettingsPane<T>
      Returns:
      settings class

    • setParams

      public void setParams(T input)
      Description copied from class: SettingsPane
      Called whenever the pane is first shown/open to set pane to show current settings.
      Specified by:
      setParams in class SettingsPane<T>
      Parameters:
      input - - current settings class.

    • getName

      public String getName()
      Description copied from class: SettingsPane
      Get the name of the pane.
      Specified by:
      getName in class SettingsPane<T>
      Returns:
      name of the pane

    • getContentNode

      public javafx.scene.Node getContentNode()
      Description copied from class: SettingsPane
      Get node for GUI change of settings.
      Specified by:
      getContentNode in class SettingsPane<T>

    • paneInitialized

      public void paneInitialized()
      Description copied from class: SettingsPane
      Called when settings pane is first initialised. This can be used if for example, a the size of a pane is needed for a param. (Sizes are only initialised when Nodes are shown);
      Specified by:
      paneInitialized in class SettingsPane<T>