Package adams.flow.sink

Class FilePreview

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ClearableDisplay, DisplayTypeSupporter, ErrorHandler, InputConsumer, ComponentSupplier, DisplayPanelProvider, MenuBarProvider, SendToActionSupporter, Serializable, Comparable
    public class FilePreview
extends AbstractGraphicalDisplay
implements DisplayPanelProvider
    Actor for previewing file contents. Skips archives (if handlers available).

    Input/output:
    - accepts:
       java.lang.String
       java.io.File
       java.awt.image.BufferedImage
       adams.data.image.AbstractImageContainer


    -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: FilePreview
 
    -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 gets stopped in case this actor encounters an error;
     useful for critical actors.
    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
 
    -display-in-editor <boolean> (property: displayInEditor)
    If enabled displays the panel in a tab in the flow editor rather than in 
    a separate frame.
    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
 
    -writer <adams.gui.print.JComponentWriter> (property: writer)
    The writer to use for generating the graphics output.
    default: adams.gui.print.NullWriter
 
    -use-custom-preview <boolean> (property: useCustomPreview)
    If enabled the specified preview handler is used for all files rather than 
    'automagically' determined.
    default: false
 
    -preview <adams.gui.tools.previewbrowser.AbstractContentHandler> (property: preview)
    The custom preview to use.
    default: adams.gui.tools.previewbrowser.PlainTextHandler
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_WrapperPanel

        protected BasePanel m_WrapperPanel
        the wrapper panel.

      • m_PreviewPanel

        protected PreviewPanel m_PreviewPanel
        the panel with the preview.

      • m_UseCustomPreview

        protected boolean m_UseCustomPreview
        whether to use a custom preview.

      • m_Preview

        protected ContentHandler m_Preview
        the width of the image properties.

    • Constructor Detail

      • FilePreview

        public FilePreview()

    • Method Detail

      • getDefaultWidth

        protected int getDefaultWidth()
        Returns the default width for the dialog.
        Overrides:
        getDefaultWidth in class AbstractDisplay
        Returns:
        the default width

      • getDefaultHeight

        protected int getDefaultHeight()
        Returns the default height for the dialog.
        Overrides:
        getDefaultHeight in class AbstractDisplay
        Returns:
        the default height

      • setUseCustomPreview

        public void setUseCustomPreview​(boolean value)
        Sets whether to use a specific preview handler rather than trying to automatically determine handler.
        Parameters:
        value - if true then use custom preview

      • getUseCustomPreview

        public boolean getUseCustomPreview()
        Returns whether to use a specific preview handler rather than trying to automatically determine handler..
        Returns:
        true if to use custom preview

      • useCustomPreviewTipText

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

      • setPreview

        public void setPreview​(ContentHandler value)
        Sets the custom preview handler to use.
        Parameters:
        value - the preview handler

      • getPreview

        public ContentHandler getPreview()
        Returns the custom preview handler to use.
        Returns:
        the preview handler

      • previewTipText

        public String previewTipText()
        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.
        Specified by:
        accepts in interface InputConsumer
        Returns:
        java.lang.String.class, java.io.File.class, java.awt.image.BufferedImage.class, adams.data.image.AbstractImageContainer.class

      • display

        protected void display​(Token token)
        Displays the token (the panel and dialog have already been created at this stage).
        Specified by:
        display in class AbstractDisplay
        Parameters:
        token - the token to display

      • createDisplayPanel

        public DisplayPanel createDisplayPanel​(Token token)
        Creates a new panel for the token.
        Specified by:
        createDisplayPanel in interface DisplayPanelProvider
        Parameters:
        token - the token to display in a new panel, can be null
        Returns:
        the generated panel

      • displayPanelRequiresScrollPane

        public boolean displayPanelRequiresScrollPane()
        Returns whether the created display panel requires a scroll pane or not.
        Specified by:
        displayPanelRequiresScrollPane in interface DisplayPanelProvider
        Returns:
        true if the display panel requires a scroll pane