Class ObjectPreview

  • 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 ObjectPreview
    extends AbstractGraphicalDisplay
    implements DisplayPanelProvider
    Actor for previewing file contents. Skips archives (if handlers available).

    - accepts:

    -logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
        The logging level for outputting errors and debugging output.
        default: WARNING
        min-user-mode: Expert
    -name <java.lang.String> (property: name)
        The name of the actor.
        default: ObjectPreview
    -annotation <adams.core.base.BaseAnnotation> (property: annotations)
        The annotations to attach to this actor.
    -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
        default: false
        min-user-mode: Expert
    -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
        min-user-mode: Expert
    -short-title <boolean> (property: shortTitle)
        If enabled uses just the name for the title instead of the actor's full
        default: false
    -display-type <adams.flow.core.displaytype.AbstractDisplayType> (property: displayType)
        Determines how to show the display, eg as standalone frame (default) or
        in the Flow editor window.
        default: adams.flow.core.displaytype.Default
        min-user-mode: Expert
    -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
    -show-flow-control-submenu <boolean> (property: showFlowControlSubMenu)
        If enabled, adds a flow control sub-menu to the menubar.
        default: false
        min-user-mode: Expert
    -use-custom-preview <boolean> (property: useCustomPreview)
        If enabled the specified preview handler is used for all files rather than
        'automagically' determined.
        default: false
    -preview <> (property: preview)
        The custom preview to use.
    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.
    • Constructor Detail

      • ObjectPreview

        public ObjectPreview()
    • Method Detail

      • getDefaultWidth

        protected int getDefaultWidth()
        Returns the default width for the dialog.
        getDefaultWidth in class AbstractDisplay
        the default width
      • getDefaultHeight

        protected int getDefaultHeight()
        Returns the default height for the dialog.
        getDefaultHeight in class AbstractDisplay
        the default height
      • setUseCustomPreview

        public void setUseCustomPreview​(boolean value)
        Sets whether to use a specific preview handler rather than trying to automatically determine handler.
        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..
        true if to use custom preview
      • useCustomPreviewTipText

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

        public void setPreview​(ObjectContentHandler value)
        Sets the custom preview handler to use.
        value - the preview handler
      • getPreview

        public ObjectContentHandler getPreview()
        Returns the custom preview handler to use.
        the preview handler
      • previewTipText

        public String previewTipText()
        Returns the tip text for this property.
        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
        the accepted classes
      • 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
        token - the token to display
      • createDisplayPanel

        public DisplayPanel createDisplayPanel​(Token token)
        Creates a new panel for the token.
        Specified by:
        createDisplayPanel in interface DisplayPanelProvider
        token - the token to display in a new panel, can be null
        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
        true if the display panel requires a scroll pane