Constructor Detail

• AbstractStampFormat

  public AbstractStampFormat(String[] allowedFormatUnits,
                             String name,
                             boolean supportCustomSuffix,
                             boolean supportCustomFormat,
                             boolean supportDecimalPlaces)

  Parameters:

  allowedFormatUnits -

  name -

  supportCustomSuffix -

  supportCustomFormat -

Method Detail

• getLabelString

  public abstract String getLabelString(double labelValue)

  Here we make the strings to print into the images. decide if the format is digital or decimal according to the plugin GUI input if it is decimal (not digital) then need to set suffix from drop down list which might be custom suffix if one is entered and selected. if it is digital, then there is no suffix as format is set default as hh:mm:ss.ms

  Parameters:

  labelValue - The value to a frame of which the label should be generated

  Returns:

  The string representation of the label value

• lastLabelString

  public String lastLabelString()

  this method returns the string of the label for the last frame to be stamped which is for the frame with value of the last variable. It should be the longest string the label will be. we should use this in maxWidth method and for the preview of the label used to be: maxWidth = ip.getStringWidth(decimalString(start + interval*imp.getStackSize())); but should use last not stack size, since no label is made for slices after last? It also needs to calculate maxWidth for both digital and decimal label formats:

  Returns:

• suffix

  public String suffix()

  Gets the suffix (if any) that should be appended to the label.

  Returns:

  The suffix to display.

• getAllowedFormatUnits

  public String[] getAllowedFormatUnits()

  Gets an array of allowed units for the format. eg. to display them in a drop down choice list.

  Returns:

  The allowed units.

• getName

  public String getName()

  Gets the display name of the format.

  Returns:

  The display name of the format

• supportsCustomSuffix

  public boolean supportsCustomSuffix()

  Indicates whether custom (user input) suffixes are allowed for this format or not.

  Returns:

  True if custom suffixes are allowed, false otherwise

• supportsCustomFormat

  public boolean supportsCustomFormat()

  Indicates whether a custom label format can be used by the format. This could be useful for digital formats like HH:mm which should be user definable.

  Returns:

  True if the format supports custom formats, false otherwise.

• supportsDecimalPlaces

  public boolean supportsDecimalPlaces()

  Indicates whether decimal places are part of the format. This could be useful for decimal formats for which the number of decimal places should be user definable.

  Returns:

  True if the format supports decimal places, false otherwise.