Package adams.flow.transformer

Class SpreadSheetCellSelector

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, InteractiveActor, OutputProducer, StopModeSupporter, Serializable, Comparable
    public class SpreadSheetCellSelector
extends AbstractInteractiveTransformerDialog
    Lets the user highlight cells in a spreadsheet which get output:
    - spreadsheet with coordinates (1-based row and column) and the associated value of the selected cell
    - spreadsheet with all un-selected cells set to missing
    Usage:
    You select cells by left-clicking on them and/or holding the left mouse button and moving the mouse over the cells that you want to select.
    You can unselect cells in the same fashion, by holding the shift key in addition.

    Input/output:
    - accepts:
       adams.data.spreadsheet.SpreadSheet
    - generates:
       adams.flow.container.SpreadSheetCellSelectionContainer


    Container information:
    - adams.flow.container.SpreadSheetCellSelectionContainer: Original, Selected, Subset 

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 
    -name <java.lang.String> (property: name)
    The name of the actor.
    default: SpreadSheetCellSelector
 
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default:
 
    -skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
    default: false
 
    -stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow execution at this level gets stopped in case this
    actor encounters an error; the error gets propagated; useful for critical
    actors.
    default: false
 
    -silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing
    actor handler must have this enabled as well.
    default: false
 
    -short-title <boolean> (property: shortTitle)
    If enabled uses just the name for the title instead of the actor's full
    name.
    default: false
 
    -width <int> (property: width)
    The width of the dialog.
    default: 800
    minimum: 1
 
    -height <int> (property: height)
    The height of the dialog.
    default: 600
    minimum: 1
 
    -x <int> (property: x)
    The X position of the dialog (>=0: absolute, -1: left, -2: center, -3: right
    ).
    default: -1
    minimum: -3
 
    -y <int> (property: y)
    The Y position of the dialog (>=0: absolute, -1: top, -2: center, -3: bottom
    ).
    default: -1
    minimum: -3
 
    -stop-if-canceled <boolean> (property: stopFlowIfCanceled)
    If enabled, the flow gets stopped in case the user cancels the dialog.
    default: false
 
    -custom-stop-message <java.lang.String> (property: customStopMessage)
    The custom stop message to use in case a user cancelation stops the flow
    (default is the full name of the actor)
    default:
 
    -stop-mode <GLOBAL|STOP_RESTRICTOR> (property: stopMode)
    The stop mode to use.
    default: GLOBAL
 
    -font <java.awt.Font> (property: font)
    The font of the table.
    default: Monospaced-PLAIN-12
 
    -color-selected <java.awt.Color> (property: colorSelected)
    The (background) color for the selected cells.
    default: #22ff0000
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Font

        protected Font m_Font
        the font to use.

      • m_ColorSelected

        protected Color m_ColorSelected
        the color for selected cells.

      • m_ButtonOK

        protected BaseButton m_ButtonOK
        the button for accepting.

      • m_ButtonCancel

        protected BaseButton m_ButtonCancel
        the button for cancelling.

      • m_Accepted

        protected boolean m_Accepted
        whether the token was accepted.

      • m_Waiting

        protected Boolean m_Waiting
        whether we're currenlty waiting on the user.

    • Constructor Detail

      • SpreadSheetCellSelector

        public SpreadSheetCellSelector()

    • Method Detail

      • getDefaultFont

        protected Font getDefaultFont()
        Returns the default font for the dialog.
        Returns:
        the default font

      • setFont

        public void setFont​(Font value)
        Sets the font of the table.
        Parameters:
        value - the font

      • getFont

        public Font getFont()
        Returns the currently set font of the table.
        Returns:
        the font

      • fontTipText

        public String fontTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setColorSelected

        public void setColorSelected​(Color value)
        Sets the color for selected cells.
        Parameters:
        value - the color

      • getColorSelected

        public Color getColorSelected()
        Returns the color for selected cells.
        Returns:
        the color

      • colorSelectedTipText

        public String colorSelectedTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Returns:
        the Class of objects that can be processed

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Returns:
        the Class of the generated tokens