Package ca.corbett.extras.audio

Class WaveformConfigField

java.lang.Object
ca.corbett.forms.fields.FormField
ca.corbett.extras.audio.WaveformConfigField
public final class WaveformConfigField extends FormField
A ConfigPanel instance that allows viewing and editing settings for a WaveformConfig object.
Since:
2018-01-25
Author:
scorbo2

  • Constructor Details

    • WaveformConfigField

      public WaveformConfigField(String label)

  • Method Details

    • isMultiLine

      public boolean isMultiLine()
      Description copied from class: FormField
      By default, FormFields occupy a single "line", or row, on the form. However, some FormFields may have a field component that spans multiple lines, like a multi-line text box, or a list, or a custom panel. Descendant classes can override the default false value here. It controls the placement of the field label. For tall form fields, the field label will be anchored to the top-left of its area.
      Overrides:
      isMultiLine in class FormField

    • setShouldExpand

      public WaveformConfigField setShouldExpand(boolean should)

    • shouldExpand

      public boolean shouldExpand()
      Description copied from class: FormField
      By default, FormPanel will allocate only the space that the field component requires. Descendant classes can override the default false value here to indicate that their field component should be allowed to expand as much space as is available to it. For example: PanelField.
      Overrides:
      shouldExpand in class FormField

    • hasValidationLabel

      public boolean hasValidationLabel()
      This field itself typically will not show a validation label, as we delegate field validation to our embedded form fields. But, in keeping with the swing-forms general contract, you can still assign FieldValidators to instances of this field if you wish.
      Overrides:
      hasValidationLabel in class FormField

    • validate

      public boolean validate()
      Description copied from class: FormField
      Asks all registered FieldValidators (if any) to check the current value of this field to make sure it's valid. If no FieldValidators are registered, then the field is valid by default (i.e. no checking is done). If any validator returns false, then this method will return false.

      Updating the UI: this method will make the validation label to the right of the FormField visible automatically and will set its icon as appropriate. Tooltip text will be available in the case of a failed validation, to explain why the field is invalid.

      Overrides:
      validate in class FormField
      Returns:
      True if the field value is valid according to all our validators, false otherwise.

    • setUseTitleBorder

      public WaveformConfigField setUseTitleBorder(boolean use)
      Decides whether to use a titled border around this field component (the default), or to use a traditional FormField field label instead.

    • isUseTitleBorder

      public boolean isUseTitleBorder()

    • getFieldLabelText

      public String getFieldLabelText()
      Returns the text that is either showing in the field label OR in the field's title border, depending on the value of useTitleBorder.

    • setFieldLabelText

      public WaveformConfigField setFieldLabelText(String text)

    • setBgColor

      public WaveformConfigField setBgColor(Color col)

    • getBgColor

      public Color getBgColor()

    • setWaveformColor

      public WaveformConfigField setWaveformColor(Color col)

    • getWaveformColor

      public Color getWaveformColor()

    • setOutlineColor

      public WaveformConfigField setOutlineColor(Color col)

    • getOutlineColor

      public Color getOutlineColor()

    • setBaselineColor

      public WaveformConfigField setBaselineColor(Color col)

    • getBaselineColor

      public Color getBaselineColor()

    • setBaselineWidth

      public WaveformConfigField setBaselineWidth(int width)

    • getBaselineWidth

      public int getBaselineWidth()

    • setOutlineWidth

      public WaveformConfigField setOutlineWidth(int width)

    • getOutlineWidth

      public int getOutlineWidth()

    • setEnableDrawBaseline

      public WaveformConfigField setEnableDrawBaseline(boolean enable)

    • isEnableDrawBaseline

      public boolean isEnableDrawBaseline()

    • setEnableDrawOutline

      public WaveformConfigField setEnableDrawOutline(boolean enable)

    • isEnableDrawOutline

      public boolean isEnableDrawOutline()

    • setCompression

      public WaveformConfigField setCompression(WaveformConfigField.Compression compression)

    • getCompression

      public WaveformConfigField.Compression getCompression()

    • setWidthLimit

      public WaveformConfigField setWidthLimit(WaveformConfigField.WidthLimit limit)

    • getWidthLimit

      public WaveformConfigField.WidthLimit getWidthLimit()