Package adams.flow.sink

Class Display

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, TextSupporter, VariablesInspectionHandler, VariableChangeListener, Actor, ClearableDisplay, DisplayTypeSupporter, ErrorHandler, FlowControlSubMenuSupporter, HeadlessExecutionSupporter, InputConsumer, DisplayPanelProvider, TextSupplier, MenuBarProvider, SendToActionSupporter, Serializable, Comparable
    public class Display
extends AbstractTextualDisplay
implements DisplayPanelProvider
    Actor that outputs any object that arrives at its input port via the 'toString()' method.

    Input/output:
    - accepts:
       java.lang.Object


    -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: Display
 
    -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
    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
    name.
    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: 640
    minimum: -1
 
    -height <int> (property: height)
    The height of the dialog.
    default: 480
    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
 
    -font <java.awt.Font> (property: font)
    The font of the dialog.
    default: Monospaced-PLAIN-12
 
    -always-clear <boolean> (property: alwaysClear)
    If enabled, the display is always cleared before processing a token.
    default: false
 
    -show-flow-control-submenu <boolean> (property: showFlowControlSubMenu)
    If enabled, adds a flow control sub-menu to the menubar.
    default: false
    min-user-mode: Expert
 
    -writer <adams.data.io.output.AbstractTextWriter> (property: writer)
    The writer to use for storing the textual output.
    default: adams.data.io.output.NullWriter
 
    -line-wrap <boolean> (property: lineWrap)
    If enabled, line wrap is used.
    default: false
 
    -wrap-style-word <boolean> (property: wrapStyleWord)
    If enabled, wrapping occurs on word boundaries instead of character boundaries.
    default: false
 
    -max-lines <int> (property: maxLines)
    The maximum number of lines to keep at the end of the document; <= no limit.
    default: -1
    minimum: -1
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_MenuItemFilePrint

        protected JMenuItem m_MenuItemFilePrint
        the print menu item.

      • m_MenuItemEditUndo

        protected JMenuItem m_MenuItemEditUndo
        the undo menu item.

      • m_MenuItemEditRedo

        protected JMenuItem m_MenuItemEditRedo
        the redo menu item.

      • m_MenuItemEditCut

        protected JMenuItem m_MenuItemEditCut
        the cut menu item.

      • m_MenuItemEditCopy

        protected JMenuItem m_MenuItemEditCopy
        the copy menu item.

      • m_MenuItemEditPaste

        protected JMenuItem m_MenuItemEditPaste
        the paste menu item.

      • m_MenuItemEditSelectAll

        protected JMenuItem m_MenuItemEditSelectAll
        the select all menu item.

      • m_MenuItemEditFind

        protected JMenuItem m_MenuItemEditFind
        the find menu item.

      • m_MenuItemEditFindNext

        protected JMenuItem m_MenuItemEditFindNext
        the find next menu item.

      • m_MenuItemViewFont

        protected JMenuItem m_MenuItemViewFont
        the font menu item.

      • m_MenuItemViewLineWrap

        protected JMenuItem m_MenuItemViewLineWrap
        the line wrap menu item.

      • m_MenuItemViewWrapStyleWord

        protected JMenuItem m_MenuItemViewWrapStyleWord
        the word wrap style menu item.

      • m_LineWrap

        protected boolean m_LineWrap
        use line wrap.

      • m_WrapStyleWord

        protected boolean m_WrapStyleWord
        use word wrap style.

      • m_MaxLines

        protected int m_MaxLines
        the maximum number of lines to keep.

    • Constructor Detail

      • Display

        public Display()

    • 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

      • setLineWrap

        public void setLineWrap​(boolean value)
        Enables/disables line wrap.
        Parameters:
        value - if true line wrap gets enabled

      • getLineWrap

        public boolean getLineWrap()
        Returns whether line wrap is enabled.
        Returns:
        true if line wrap enabled

      • lineWrapTipText

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

      • setWrapStyleWord

        public void setWrapStyleWord​(boolean value)
        Sets the style of wrapping used if the text area is wrapping lines. If set to true the lines will be wrapped at word boundaries (whitespace) if they are too long to fit within the allocated width. If set to false, the lines will be wrapped at character boundaries. By default this property is false.
        Parameters:
        value - indicates if word boundaries should be used for line wrapping

      • getWrapStyleWord

        public boolean getWrapStyleWord()
        Gets the style of wrapping used if the text area is wrapping lines. If set to true the lines will be wrapped at word boundaries (ie whitespace) if they are too long to fit within the allocated width. If set to false, the lines will be wrapped at character boundaries.
        Returns:
        if the wrap style should be word boundaries instead of character boundaries

      • wrapStyleWordTipText

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

      • setMaxLines

        public void setMaxLines​(int value)
        Sets the maximum number of lines to keep at the end of the document.
        Parameters:
        value - the maximum, <= for no limit

      • getMaxLines

        public int getMaxLines()
        Returns the maximum number of lines to keep at the end of the document.
        Returns:
        the maximum, <=0 for no limit

      • maxLinesTipText

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

      • createEditMenu

        protected JMenu createEditMenu()
        Creates the "Edit" menu.
        Returns:
        the menu

      • createViewMenu

        protected JMenu createViewMenu()
        Creates the "Edit" menu.
        Returns:
        the menu

      • accepts

        public Class[] accepts()
        Returns the class that the consumer accepts.
        Specified by:
        accepts in interface InputConsumer
        Returns:
        java.lang.Object.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 display 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