Wrap dialogs to multiple lines automatically.

jussimalinen · jussimalinen · commit fe79c361fc57 · 2013-04-29T13:54:56.000+03:00
Update issue 1405
status: done

Implemented on both jython and python. Also added note to docs about wrapping with newline.
diff --git a/atest/testdata/standard_libraries/dialogs/dialogs.txt b/atest/testdata/standard_libraries/dialogs/dialogs.txt
@@ -1,15 +1,19 @@
 *** Settings ***
 Library         Dialogs
 
+*** Variable ***
+${FILLER} =     wrapped${SPACE}
+
+
 *** Test Cases ***
 Pause Execution
     Pause Execution    Press OK.
 
 Pause Execution With Long Line
-    Pause Execution    Verify that this pretty long text is displayed nicely. And then press OK.
+    Pause Execution    Verify that the long text below is wrapped nicely.\n\n${FILLER*200}\n\nAnd then press OK.
 
 Pause Execution With Multiple Lines
-    Pause Execution    And verify that\nthis pretty\nlong text\nis displayed\nnicely.\n\nAnd then press OK.
+    Pause Execution    Verify that\nthis multi\nline text\nis displayed\nnicely.\n\nAnd then press OK.
 
 Execute Manual Step Passing
     Execute Manual Step    Press PASS.
diff --git a/src/robot/libraries/Dialogs.py b/src/robot/libraries/Dialogs.py
@@ -19,6 +19,10 @@
 dialogs are slightly different depending on are tests run on Python or
 Jython but they provide the same functionality.
 
+Long lines in the provided messages are wrapped automatically since
+Robot Framework 2.8. If you want to wrap lines manually, you can add
+newlines using \\n character sequence.
+
 The library has following two limitations:
 - It is not compatible with IronPython.
 - It cannot be used with timeouts on Python.
diff --git a/src/robot/libraries/dialogs_jy.py b/src/robot/libraries/dialogs_jy.py
@@ -41,17 +41,23 @@ def _get_value(self, pane):
         return value if value != UNINITIALIZED_VALUE else None
 
 
+class WrappedOptionPane(JOptionPane):
+
+    def getMaxCharactersPerLineCount(self):
+        return 120
+
+
 class MessageDialog(_SwingDialog):
 
     def __init__(self, message):
-        pane = JOptionPane(message, PLAIN_MESSAGE, DEFAULT_OPTION)
+        pane = WrappedOptionPane(message, PLAIN_MESSAGE, DEFAULT_OPTION)
         _SwingDialog.__init__(self, pane)
 
 
 class InputDialog(_SwingDialog):
 
     def __init__(self, message, default):
-        pane = JOptionPane(message, PLAIN_MESSAGE, OK_CANCEL_OPTION)
+        pane = WrappedOptionPane(message, PLAIN_MESSAGE, OK_CANCEL_OPTION)
         pane.setWantsInput(True)
         pane.setInitialSelectionValue(default)
         _SwingDialog.__init__(self, pane)
@@ -60,7 +66,7 @@ def __init__(self, message, default):
 class SelectionDialog(_SwingDialog):
 
     def __init__(self, message, options):
-        pane = JOptionPane(message, PLAIN_MESSAGE, OK_CANCEL_OPTION)
+        pane = WrappedOptionPane(message, PLAIN_MESSAGE, OK_CANCEL_OPTION)
         pane.setWantsInput(True)
         pane.setSelectionValues(options)
         _SwingDialog.__init__(self, pane)
@@ -69,8 +75,8 @@ def __init__(self, message, options):
 class PassFailDialog(_SwingDialog):
 
     def __init__(self, message):
-        pane = JOptionPane(message, PLAIN_MESSAGE, YES_NO_OPTION,
-                           None, ['PASS', 'FAIL'], 'PASS')
+        pane = WrappedOptionPane(message, PLAIN_MESSAGE, YES_NO_OPTION,
+                                 None, ['PASS', 'FAIL'], 'PASS')
         _SwingDialog.__init__(self, pane)
 
     def _get_value(self, pane):
diff --git a/src/robot/libraries/dialogs_py.py b/src/robot/libraries/dialogs_py.py
@@ -65,7 +65,7 @@ def _bring_to_front(self):
 
     def _create_body(self, message, value):
         frame = Frame(self)
-        Label(frame, text=message, anchor=W, justify=LEFT).pack(fill=BOTH)
+        Label(frame, text=message, anchor=W, justify=LEFT, wraplength=800).pack(fill=BOTH)
         selector = self._create_selector(frame, value)
         if selector:
             selector.pack(fill=BOTH)
