Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e3RvYzptYXhMZXZlbD0zfGluZGVudD0wcHh9&amp;locale=en_GB&amp;version=2" data-macro-name="toc" data-macro-parameters="indent=0px|maxLevel=3">
(Automatically generated from BeanInfo)

<h3>Generated Object</h3>

A javax.swing.JOptionPane is returned, unless the user passes in a subclass of JOptionPane as the value argument, in which case the value argument is returned.

<h3>Attributes</h3>

<h4>Declared in javax.swing.JOptionPane</h4>

<ul>
	<li>UI &lt;OptionPaneUI&gt; The UI object that implements the optionpane's LookAndFeel</li>
	<li>icon &lt;Icon&gt; The option pane's type icon.</li>
	<li>initialSelectionValue &lt;Object&gt; The option pane's initial selection value object.</li>
	<li>initialValue &lt;Object&gt; The option pane's initial value object.</li>
	<li>inputValue &lt;Object&gt; The option pane's input value object.</li>
	<li>message &lt;Object&gt; The optionpane's message object.</li>
	<li>messageType &lt;int&gt; The option pane's message type.</li>
	<li>optionType &lt;int&gt; The option pane's option type.</li>
	<li>options &lt;Object[]&gt; The option pane's options objects.</li>
	<li>selectionValues &lt;Object[]&gt; The option pane's selection values.</li>
	<li>value &lt;Object&gt; The option pane's value object.</li>
	<li>wantsInput &lt;boolean&gt; Flag which allows the user to input a value.</li>
</ul>

<ul>
	<li>maxCharactersPerLineCount &lt;int&gt;</li>
</ul>

<h4>Declared in javax.swing.JComponent</h4>

<ul>
	<li>autoscrolls &lt;boolean&gt; Determines if this component automatically scrolls its contents when dragged.</li>
	<li>border &lt;Border&gt; The component's border.</li>
	<li>componentPopupMenu &lt;JPopupMenu&gt; Popup to show</li>
	<li>debugGraphicsOptions &lt;int&gt; Diagnostic options for graphics operations.</li>
	<li>inheritsPopupMenu &lt;boolean&gt; Whether or not the JPopupMenu is inherited</li>
	<li>inputVerifier &lt;InputVerifier&gt; The component's input verifier.</li>
	<li>opaque &lt;boolean&gt; The component's opacity</li>
	<li>toolTipText &lt;String&gt; The text to display in a tool tip.</li>
	<li>transferHandler &lt;TransferHandler&gt; Mechanism for transfer of data to and from the component</li>
	<li>verifyInputWhenFocusTarget &lt;boolean&gt; Whether the Component verifies input before accepting focus.</li>
</ul>

<ul>
	<li>UIClassID &lt;String&gt;</li>
	<li>accessibleContext &lt;AccessibleContext&gt;</li>
	<li>actionMap &lt;ActionMap&gt;</li>
	<li>doubleBuffered &lt;boolean&gt;</li>
	<li>graphics &lt;Graphics&gt;</li>
	<li>height &lt;int&gt;</li>
	<li>managingFocus &lt;boolean&gt;</li>
	<li>nextFocusableComponent &lt;Component&gt;</li>
	<li>optimizedDrawingEnabled &lt;boolean&gt;</li>
	<li>paintingTile &lt;boolean&gt;</li>
	<li>registeredKeyStrokes &lt;KeyStroke[]&gt;</li>
	<li>requestFocusEnabled &lt;boolean&gt;</li>
	<li>rootPane &lt;JRootPane&gt;</li>
	<li>topLevelAncestor &lt;Container&gt;</li>
	<li>validateRoot &lt;boolean&gt;</li>
	<li>visibleRect &lt;Rectangle&gt;</li>
	<li>width &lt;int&gt;</li>
	<li>x &lt;int&gt;</li>
	<li>y &lt;int&gt;</li>
</ul>

<h4>Declared in java.awt.Container</h4>

<ul>
	<li>alignmentX &lt;float&gt;</li>
	<li>alignmentY &lt;float&gt;</li>
	<li>componentCount &lt;int&gt;</li>
	<li>components &lt;Component[]&gt;</li>
	<li>focusCycleRoot &lt;boolean&gt;</li>
	<li>focusTraversalPolicy &lt;FocusTraversalPolicy&gt;</li>
	<li>focusTraversalPolicyProvider &lt;boolean&gt;</li>
	<li>focusTraversalPolicySet &lt;boolean&gt;</li>
	<li>insets &lt;Insets&gt;</li>
	<li>layout &lt;LayoutManager&gt;</li>
	<li>maximumSize &lt;Dimension&gt;</li>
	<li>minimumSize &lt;Dimension&gt;</li>
	<li>preferredSize &lt;Dimension&gt;</li>
</ul>

<h4>Declared in java.awt.Component</h4>

<ul>
	<li>background &lt;Color&gt;</li>
	<li>enabled &lt;boolean&gt;</li>
	<li>focusable &lt;boolean&gt;</li>
	<li>font &lt;Font&gt;</li>
	<li>foreground &lt;Color&gt;</li>
	<li>name &lt;String&gt;</li>
	<li>visible &lt;boolean&gt;</li>
</ul>

<h3>Events</h3>

<h4>Declared in javax.swing.JComponent</h4>

<ul>
	<li>vetoableChange (PropertyChangeEvent) - part of VetoableChangeListener</li>
	<li>ancestorMoved (AncestorEvent) - part of AncestorListener</li>
	<li>ancestorAdded (AncestorEvent) - part of AncestorListener</li>
	<li>ancestorRemoved (AncestorEvent) - part of AncestorListener</li>
</ul>

<h4>Declared in java.awt.Container</h4>

<ul>
	<li>componentAdded (ContainerEvent) - part of ContainerListener</li>
	<li>componentRemoved (ContainerEvent) - part of ContainerListener</li>
</ul>

<h4>Declared in java.awt.Component</h4>

<ul>
	<li>keyPressed (KeyEvent) - part of KeyListener</li>
	<li>keyReleased (KeyEvent) - part of KeyListener</li>
	<li>keyTyped (KeyEvent) - part of KeyListener</li>
	<li>componentHidden (ComponentEvent) - part of ComponentListener</li>
	<li>componentMoved (ComponentEvent) - part of ComponentListener</li>
	<li>componentResized (ComponentEvent) - part of ComponentListener</li>
	<li>componentShown (ComponentEvent) - part of ComponentListener</li>
	<li>hierarchyChanged (HierarchyEvent) - part of HierarchyListener</li>
	<li>mouseClicked (MouseEvent) - part of MouseListener</li>
	<li>mouseEntered (MouseEvent) - part of MouseListener</li>
	<li>mouseExited (MouseEvent) - part of MouseListener</li>
	<li>mousePressed (MouseEvent) - part of MouseListener</li>
	<li>mouseReleased (MouseEvent) - part of MouseListener</li>
	<li>mouseDragged (MouseEvent) - part of MouseMotionListener</li>
	<li>mouseMoved (MouseEvent) - part of MouseMotionListener</li>
	<li>propertyChange (PropertyChangeEvent) - part of PropertyChangeListener</li>
	<li>ancestorMoved (HierarchyEvent) - part of HierarchyBoundsListener</li>
	<li>ancestorResized (HierarchyEvent) - part of HierarchyBoundsListener</li>
	<li>focusGained (FocusEvent) - part of FocusListener</li>
	<li>focusLost (FocusEvent) - part of FocusListener</li>
	<li>mouseWheelMoved (MouseWheelEvent) - part of MouseWheelListener</li>
	<li>caretPositionChanged (InputMethodEvent) - part of InputMethodListener</li>
	<li>inputMethodTextChanged (InputMethodEvent) - part of InputMethodListener</li>
</ul>

<h3>Content</h3>

<h3>Usage</h3>

<h3>Examples</h3>
 
<table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>
import groovy.swing.SwingBuilder

import javax.swing.*

def swingBuilder = new SwingBuilder()
def options = ['1995', '2003', '2007']
def pane = swingBuilder.optionPane(message:'Groovy starts in ', selectionValues:options, optionType:JOptionPane.CLOSED_OPTION)
def dialog = pane.createDialog(null, 'worthless message')
dialog.show()

pane = swingBuilder.optionPane(    message:'Are you sure that Groovy starts in ',
                                   selectionValues:options,
                                   initialSelectionValue:pane.getInputValue(),
                                   messageType:JOptionPane.QUESTION_MESSAGE,
                                   optionType:JOptionPane.OK_CANCEL_OPTION)
dialog = pane.createDialog(null, 'worthless message')
dialog.show()

def choice
def lastPane = swingBuilder.optionPane()
choice = lastPane.showOptionDialog(     null,
                        'worthless message',
                        'Last chance : Groovy starts in ',
                        JOptionPane.YES_NO_CANCEL_OPTION,
                        JOptionPane.QUESTION_MESSAGE,
                        null,
                        options as Object[],
                        pane.getInputValue())
                       
println options[choice]
</pre></td></tr></table>

<h3>Observable Attributes</h3>

<ul>
	<li>UI</li>
	<li>alignmentX</li>
	<li>alignmentY</li>
	<li>background</li>
	<li>border</li>
	<li>component</li>
	<li>componentCount</li>
	<li>componentPopupMenu</li>
	<li>components</li>
	<li>containerListeners</li>
	<li>enabled</li>
	<li>focusCycleRoot</li>
	<li>focusTraversalKeys</li>
	<li>focusTraversalPolicy</li>
	<li>focusTraversalPolicyProvider</li>
	<li>focusTraversalPolicySet</li>
	<li>focusable</li>
	<li>font</li>
	<li>foreground</li>
	<li>icon</li>
	<li>inheritsPopupMenu</li>
	<li>initialSelectionValue</li>
	<li>initialValue</li>
	<li>inputValue</li>
	<li>inputVerifier</li>
	<li>insets</li>
	<li>layout</li>
	<li>maximumSize</li>
	<li>message</li>
	<li>messageType</li>
	<li>minimumSize</li>
	<li>opaque</li>
	<li>optionType</li>
	<li>options</li>
	<li>preferredSize</li>
	<li>selectionValues</li>
	<li>transferHandler</li>
	<li>value</li>
	<li>verifyInputWhenFocusTarget</li>
	<li>wantsInput</li>
</ul>