Class OrderWriterDialog

  • All Implemented Interfaces:
    java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.RootPaneContainer, javax.swing.WindowConstants, EventListener, GameDataListener

    public class OrderWriterDialog
    extends InternationalizedDataDialog
    A GUI for writing orders to a file or copy them to the clipboard. This class can be used as a stand-alone application or can be integrated as dialog into another application.
    See Also:
    Serialized Form
    • Nested Class Summary

      • Nested classes/interfaces inherited from class javax.swing.JDialog

        javax.swing.JDialog.AccessibleJDialog
      • Nested classes/interfaces inherited from class java.awt.Dialog

        java.awt.Dialog.AccessibleAWTDialog, java.awt.Dialog.ModalExclusionType, java.awt.Dialog.ModalityType
      • Nested classes/interfaces inherited from class java.awt.Window

        java.awt.Window.AccessibleAWTWindow, java.awt.Window.Type
      • Nested classes/interfaces inherited from class java.awt.Container

        java.awt.Container.AccessibleAWTContainer
      • Nested classes/interfaces inherited from class java.awt.Component

        java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected static java.lang.String DEFAULT_EMAIL  
      protected static int DEFAULT_FIXED_WIDTH  
      protected static int DEFAULT_MAILSERVER_PORT  
      protected static java.lang.String DEFAULT_SERVER_ADDRESS  
      protected static java.lang.String DEFAULT_SUBJECT  
      • Fields inherited from class javax.swing.JDialog

        accessibleContext, rootPane, rootPaneCheckingEnabled
      • Fields inherited from class java.awt.Dialog

        DEFAULT_MODALITY_TYPE
      • Fields inherited from class java.awt.Component

        BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
      • Fields inherited from interface java.awt.image.ImageObserver

        ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
      • Fields inherited from interface javax.swing.WindowConstants

        DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, EXIT_ON_CLOSE, HIDE_ON_CLOSE
    • Constructor Summary

      Constructors 
      Constructor Description
      OrderWriterDialog​(java.awt.Frame owner, boolean modal, GameData initData, java.util.Properties p)
      Create a new OrderWriterDialog object as a dialog with a parent window.
      OrderWriterDialog​(java.awt.Frame owner, boolean modal, GameData initData, java.util.Properties p, java.util.Collection<Region> selectedRegions)
      Create a new OrderWriterDialog object as a dialog with a parent window and a set of selected regions.
      OrderWriterDialog​(GameData data)
      Create a stand-alone instance of OrderWriterDialog.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void addFileName​(java.lang.String outputFile)  
      protected void addServerURL​(java.lang.String url)  
      static boolean canShow​(GameData data)
      Returns true if the dialog can be show for the given data, i.e., if it has privileged factions.
      protected boolean copyToClipboard()  
      protected boolean copyToClipboard​(Faction faction)  
      protected void factionChanged​(Faction faction, int type)
      If the faction changed, the configuration for the mailserver and the selected output file may changed...this method checks this.
      protected java.io.Writer getWriter​(java.io.File outputFile)  
      boolean runClipboard()
      Copies the orders to the clipboard using the settings from the properties.
      boolean runMail()
      Mails the orders using the settings from the properties.
      boolean runPutOnServer()
      Sends the orders using the settings from the properties.
      boolean runSave()
      Saves the orders to a file using the settings from the properties.
      protected boolean saveAll()  
      protected boolean saveToFile()  
      protected boolean saveToServer()  
      protected boolean sendMail()  
      protected void updateRecipient()  
      • Methods inherited from class javax.swing.JDialog

        addImpl, createRootPane, dialogInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update
      • Methods inherited from class java.awt.Dialog

        addNotify, getModalityType, getTitle, hide, isModal, isResizable, isUndecorated, setBackground, setModal, setModalityType, setOpacity, setResizable, setShape, setTitle, setUndecorated, setVisible, show, toBack
      • Methods inherited from class java.awt.Window

        addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, getBackground, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOpacity, getOwnedWindows, getOwner, getOwnerlessWindows, getShape, getToolkit, getType, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isAutoRequestFocus, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isOpaque, isShowing, isValidateRoot, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeNotify, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setAutoRequestFocus, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImage, setIconImages, setLocation, setLocation, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setType, toFront
      • Methods inherited from class java.awt.Container

        add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusDownCycle, validate, validateTree
      • Methods inherited from class java.awt.Component

        action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, resize, resize, revalidate, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setMaximumSize, setMixingCutoutShape, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • OrderWriterDialog

        public OrderWriterDialog​(GameData data)
        Create a stand-alone instance of OrderWriterDialog.
      • OrderWriterDialog

        public OrderWriterDialog​(java.awt.Frame owner,
                                 boolean modal,
                                 GameData initData,
                                 java.util.Properties p)
        Create a new OrderWriterDialog object as a dialog with a parent window.
      • OrderWriterDialog

        public OrderWriterDialog​(java.awt.Frame owner,
                                 boolean modal,
                                 GameData initData,
                                 java.util.Properties p,
                                 java.util.Collection<Region> selectedRegions)
        Create a new OrderWriterDialog object as a dialog with a parent window and a set of selected regions.
    • Method Detail

      • addServerURL

        protected void addServerURL​(java.lang.String url)
      • addFileName

        protected void addFileName​(java.lang.String outputFile)
      • factionChanged

        protected void factionChanged​(Faction faction,
                                      int type)
        If the faction changed, the configuration for the mailserver and the selected output file may changed...this method checks this.
        Parameters:
        faction -
      • updateRecipient

        protected void updateRecipient()
      • runClipboard

        public boolean runClipboard()
        Copies the orders to the clipboard using the settings from the properties.
      • copyToClipboard

        protected boolean copyToClipboard()
      • copyToClipboard

        protected boolean copyToClipboard​(Faction faction)
      • runPutOnServer

        public boolean runPutOnServer()
        Sends the orders using the settings from the properties.
      • saveToServer

        protected boolean saveToServer()
      • runMail

        public boolean runMail()
        Mails the orders using the settings from the properties.
      • sendMail

        protected boolean sendMail()
      • runSave

        public boolean runSave()
        Saves the orders to a file using the settings from the properties.
      • saveAll

        protected boolean saveAll()
      • saveToFile

        protected boolean saveToFile()
      • getWriter

        protected java.io.Writer getWriter​(java.io.File outputFile)
                                    throws java.io.IOException
        Throws:
        java.io.IOException
      • canShow

        public static boolean canShow​(GameData data)
        Returns true if the dialog can be show for the given data, i.e., if it has privileged factions.