Package PamView.symbol.modifier

Class SuperDetSymbolWrapper

java.lang.Object
PamView.symbol.modifier.SymbolModifier
PamView.symbol.modifier.SuperDetSymbolWrapper
public class SuperDetSymbolWrapper extends SymbolModifier
Wraps a symbol modifier stolen from a super detection in order to pass the super detection into the symbol modifier rather than the original sub detection.
Author:
Doug Gillespie

  • Constructor Details

  • Method Details

    • getSymbolData

      public SymbolData getSymbolData(GeneralProjector projector, PamDataUnit dataUnit)
      Description copied from class: SymbolModifier
      This is the symbol data to use if this modifier were to change everything. the Symbolchooser will actually be calling the modifySymbol function, which calls this, then based on which bits are set for modification, will transfer over the appropriate information.

      Must be able to respond to a null projector and dataUnit for tree vies.

      Specified by:
      getSymbolData in class SymbolModifier
      Parameters:
      projector -
      dataUnit -
      Returns:

    • getToolTipText

      public String getToolTipText()
      Description copied from class: SymbolModifier
      Get a tool tip to display in dialogs, menus, etc.
      Overrides:
      getToolTipText in class SymbolModifier
      Returns:
      tip text

    • getModifyableBits

      public int getModifyableBits()
      Description copied from class: SymbolModifier
      Bits that can be selected / modified. This is NOT the bits which are currently selected for modification
      Overrides:
      getModifyableBits in class SymbolModifier
      Returns:
      the modifyableBits

    • canModify

      public boolean canModify(int modType)
      Description copied from class: SymbolModifier
      Say if can modify symbol in a particular way or ways . Note that this is what it CAN do, not necessarily what it's been told to do.
      Overrides:
      canModify in class SymbolModifier
      Parameters:
      modType - bitmap of modificatio types
      Returns:

    • getDialogPanel

      public PamDialogPanel getDialogPanel()
      Overrides:
      getDialogPanel in class SymbolModifier

    • getModifierOptionsMenu

      public JMenuItem getModifierOptionsMenu()
      Description copied from class: SymbolModifier
      Get a menu item which can be added to options menu to control symbol modifier settings. by default, the menu item is only created if the getDialogPanel function returns non null, but this behaviour can be overridden for more bespoke solutions such as simple additional menu items, etc.
      Overrides:
      getModifierOptionsMenu in class SymbolModifier
      Returns:
      null or a menu item

    • showOptionsDialog

      protected void showOptionsDialog(ActionEvent e, PamDialogPanel dialogPanel)
      Description copied from class: SymbolModifier
      Default behaviour to show the dialog panel.
      Overrides:
      showOptionsDialog in class SymbolModifier
      Parameters:
      e -
      dialogPanel -

    • getOptionsPane

      public SymbolModifierPane getOptionsPane()
      Description copied from class: SymbolModifier
      Get the JavaFX symbol options pane that has options for the symbol pane.
      Overrides:
      getOptionsPane in class SymbolModifier
      Returns:
      the symbol options pane.

    • getSymbolModifierParams

      public SymbolModifierParams getSymbolModifierParams()
      Description copied from class: SymbolModifier
      Get the symbol modifier parameters associated with the symbol modifier.

      Note that this function should create a new instance of the settings class if the settings class is null. This allows subclasses to override this function to return custom parameter objects.

      Overrides:
      getSymbolModifierParams in class SymbolModifier
      Returns:
      the symbol modifier parameters.

    • setSymbolModifierParams

      public void setSymbolModifierParams(SymbolModifierParams symbolModifierParams)
      Description copied from class: SymbolModifier
      Set the symbol modifier paramters.
      Overrides:
      setSymbolModifierParams in class SymbolModifier
      Parameters:
      symbolModifierParams - - the symbol modifiers paramters.

    • setSelectionBit

      public void setSelectionBit(int selectionBit, boolean selected)
      Description copied from class: SymbolModifier
      Set a selection bit to true.
      Overrides:
      setSelectionBit in class SymbolModifier
      Parameters:
      selectionBit -
      selected -

    • setToolTipText

      public void setToolTipText(String tip)
      Description copied from class: SymbolModifier
      Set a tool tip to display in dialogs, menus, etc.
      Overrides:
      setToolTipText in class SymbolModifier
      Parameters:
      tip - tip text