Multiple value Property and JLists

[afida]

Hi, In my domain object I have mutiple value property. I want to display a avaiblable values and selected values on my form, how do I do that?



For example



Class BusinessUnit {

String name;

.......

List employees;

}



I want to have two JLists side-by-side (standard windows available-selected lists) to add (>> ) and remove (<<) the employess for this BusinessUnit. On this form page I would only have these selection lists.



Thanks



Amad

[Keith Donald]

Amad,

I'm pasting a class (a form page) where I do almost exactly this... in the left column is a "entity explorer tree" (it's hierarchical but it could be a list) where the user may select properties [aka columns] as part of building a ad-hoc query. In the right column is a List of columns the user has selected. The tree is bound to the "Entity" property on the backing form object, and the columnViewList model is bound to the "selectedProperties" property. In between the list panes are add and remove buttons. There is also a up/down button as well for manipulating the order of the selected column list.

public class QuerySelectPropertiesForm extends AbstractFormPage {
    public static final String PAGE_ID = "selectProperties";

    private EntityExplorerTree entityExplorerTree;

    private JList columnViewList;

    private JButton addButton;

    private JButton removeButton;

    private JButton upButton;

    private JButton downButton;

    public QuerySelectPropertiesForm(FormModel formModel) {
        super(formModel, PAGE_ID);
    }

    protected Entity getEntity() {
        return (Entity)getValue(Query.TOP_LEVEL_ENTITY_PROPERTY);
    }

    protected ValueModel getEntityHolder() {
        return getValueModel(Query.TOP_LEVEL_ENTITY_PROPERTY);
    }

    protected JList getList() {
        return columnViewList;
    }

    protected List getListModel() {
        return (List)getValue(Query.SELECTED_PROPERTIES);
    }

    protected JComponent createControl() {
        JPanel contentPane = new JPanel();
        contentPane.setLayout(new BoxLayout(contentPane, BoxLayout.X_AXIS));
        contentPane.add(createTreePanel());
        contentPane.add(createColumnViewPanel());
        return contentPane;
    }

    private JComponent createTreePanel() {
        ComponentFactory factory = getComponentFactory();

        initializeEntityExplorerTree();
        JComponent treeScrollPane = entityExplorerTree.getControl();
        treeScrollPane.setPreferredSize(new Dimension(175, 250));

        JLabel availableProperties = factory.createLabelFor(
                "label.availableProperties", treeScrollPane);

        JPanel treePane = new JPanel(new BorderLayout());
        treePane.add(availableProperties, BorderLayout.NORTH);
        treePane.add(treeScrollPane, BorderLayout.CENTER);
        treePane.add(createAddRemoveButtonPanel(), BorderLayout.EAST);
        return treePane;
    }

    private void initializeEntityExplorerTree() {
        entityExplorerTree = new EntityExplorerTree(getEntityHolder());
        entityExplorerTree.addSelectionListener(new TreeSelectionListener() {
            public void valueChanged(TreeSelectionEvent e) {
                onEntitySelection(entityExplorerTree.getLastSelectedObject());
            }
        });
        addFormValueListener(Query.TOP_LEVEL_ENTITY_PROPERTY, new ValueListener() {
            public void valueChanged() {
                getListModel().clear();
            }
        });
    }

    protected void onEntitySelection(PersistentMetadataObject o) {
        if (o != null) {
            addButton.setEnabled(true);
            SwingUtilities.getRootPane(addButton).setDefaultButton(addButton);
        }
        else {
            addButton.setEnabled(false);
        }
    }

    private JComponent createAddRemoveButtonPanel() {
        ComponentFactory factory = getComponentFactory();

        addButton = createAddButton();
        removeButton = createRemoveButton();

        JComponent panel = GuiStandardUtils
                .createCommandButtonColumn(new JButton[] { addButton,
                        removeButton });
        panel.setBorder(GuiStandardUtils
                .createLeftAndRightBorder(UIConstants.ONE_SPACE));
        return panel;
    }

    private JButton createAddButton() {
        JButton addButton = getComponentFactory().createButton("button.add");
        addButton.setEnabled(false);
        addButton.addActionListener(new ActionListener() {
            public void actionPerformed(ActionEvent e) {
                onAdd(entityExplorerTree.getSelectionPaths());
            }
        });
        return addButton;
    }

    protected void onAdd(TreePath[] paths) {
        for &#40;int i = 0; i < paths.length; i++&#41; &#123;
            TreePath path = paths&#91;i&#93;;
            DefaultMutableTreeNode node = &#40;DefaultMutableTreeNode&#41;path
                    .getLastPathComponent&#40;&#41;;
            PersistentMetadataObject o = &#40;PersistentMetadataObject&#41;node
                    .getUserObject&#40;&#41;;
            if &#40;o.isRootEntity&#40;&#41;&#41; &#123;
                getListModel&#40;&#41;.add&#40;new HqlSelectedEntity&#40;&#40;Entity&#41;o&#41;&#41;;
            &#125;
            else if &#40;o.isProperty&#40;&#41;&#41; &#123;
                getListModel&#40;&#41;.add&#40;new HqlSelectedProperty&#40;&#40;Property&#41;o&#41;&#41;;
            &#125;
            entityExplorerTree.clearSelection&#40;&#41;;
        &#125;
    &#125;

    private JButton createRemoveButton&#40;&#41; &#123;
        JButton removeButton = getComponentFactory&#40;&#41;.createButton&#40;
                "button.remove"&#41;;
        removeButton.setEnabled&#40;false&#41;;
        removeButton.addActionListener&#40;new ActionListener&#40;&#41; &#123;
            public void actionPerformed&#40;ActionEvent e&#41; &#123;
                int&#91;&#93; indices = columnViewList.getSelectedIndices&#40;&#41;;
                Arrays.sort&#40;indices&#41;;
                for &#40;int i = 0; i < indices.length; i++&#41; &#123;
                    getListModel&#40;&#41;.remove&#40;indices&#91;i&#93; - i&#41;;
                &#125;
            &#125;
        &#125;&#41;;
        return removeButton;
    &#125;

    private JComponent createColumnViewPanel&#40;&#41; &#123;
        this.columnViewList = createColumnViewList&#40;&#41;;
        JLabel selectedProperties = getComponentFactory&#40;&#41;.createLabelFor&#40;
                "label.selectedProperties", columnViewList&#41;;

        JScrollPane sp = new JScrollPane&#40;columnViewList&#41;;
        sp.setPreferredSize&#40;new Dimension&#40;150, entityExplorerTree.getControl&#40;&#41;
                .getPreferredSize&#40;&#41;.height&#41;&#41;;

        JPanel listPane = new JPanel&#40;new BorderLayout&#40;&#41;&#41;;
        listPane.add&#40;selectedProperties, BorderLayout.NORTH&#41;;
        listPane.add&#40;sp, BorderLayout.CENTER&#41;;
        listPane.add&#40;
                new ListItemUpDownButtonPanel&#40;columnViewList&#41;.getControl&#40;&#41;,
                BorderLayout.EAST&#41;;
        return listPane;
    &#125;

    private JList createColumnViewList&#40;&#41; &#123;
        JList columnViewList = new JList&#40;&#41;;
        final ListListModel columnViewListModel = &#40;ListListModel&#41;getFormModel&#40;&#41;
                .createBoundListModel&#40;Query.SELECTED_PROPERTIES&#41;;
        columnViewList.setModel&#40;columnViewListModel&#41;;
        columnViewList
                .setCellRenderer&#40;PersistentMetadataRenderers.LIST_CELL_RENDERER&#41;;
        columnViewList.addListSelectionListener&#40;new ListSelectionListener&#40;&#41; &#123;
            public void valueChanged&#40;ListSelectionEvent e&#41; &#123;
                if &#40;!e.getValueIsAdjusting&#40;&#41;&#41; &#123;
                    if &#40;getList&#40;&#41;.isSelectionEmpty&#40;&#41;&#41; &#123;
                        removeButton.setEnabled&#40;false&#41;;
                    &#125;
                    else &#123;
                        removeButton.setEnabled&#40;true&#41;;
                    &#125;
                &#125;
            &#125;
        &#125;&#41;;
        return columnViewList;
    &#125;

&#125;

[afida]

Thanks Keith, just a related question do you have this form on a dialog, reason I am asking because I wanted to put it on Panel, as one of the pages in compound form. I want to use tabbedPane with Apply Revert buttons, I know there is that TabbedDialogPage, basically want to similar thing but not on a dialog just Panel with TabbedPanel and button bar which is also Guarded. I am not sure how to structure this. Any help would be appreciated.

Thanks

Amad

[Keith Donald]

Amad,

The cool thing is this form page actually *is* a panel; more specifically, it's a ControlFactory that produces a JPanel. So I can stick this thing on a dialog or part of tab pane, or whatever.

TabbedDialogPages can be reused in other places besides dialogs, though I admit they are intended to be used generally in conjunction with the TitledApplicationDialog to allow for multiple dialog pages, switchable via tabs, typically with an OK and Cancel button as part of an edit transaction (and a title / message area at the top.) Of course, this is customizable, as the pages themselves are independent of the dialog or other control they are contained on.

If you just want plain old TabPanes, maybe just consider just using JTabbedPane. There is a ComponentFactory method that makes them easier to create. But I'd still consider using TabbedDialogPage as it makes it easy to add individual forms, where each form is generally a single tab and edits a subset of the properties of the backing compound form object.

As far as button bars, this is where the command framework commands in handy. Command groups can produce button bars, in addition to popup menus. Commands are also all implement Guarded. So for example, in my application I have a button bar as part of a form page on a dialog that displays several buttons where each button executes an ActionCommand or ToggleCommand (or maybe a pull-down button menu if it it's a group.) I can use the same command group to produce a popup menu with exactly the same commands, only this time they're realized as menu items. It's good user interface design: typically the button bar will be positioned below the object it allows manipulation of, and the popup menu will display when you right click on the object.

Hope this helps!

[afida]

Thanks Keith, now I am using TabbedDialogPage to get my Tabbed forms. But shouldn't there be a CompositeFormPage and then a concrete implementation
TabbedFormPage? I mean its TabbedDialogPage is working for me but I just don't like to use dialog pages in my JPanel even though it just in the name. Also having a TabbedFormPage with button bar would be suitable for dialogs or can also be used for other panels. Like in my case where i have navigation tree on the left and selected domain object's properties (as TabbedPane) on the left. Right now I have to sort of work indirectly through this TabbedDialogPage and put it on a panel with a button bar (Apply Revert Help). If we had something in form package that does that then we can also use it for dialogs, similar to FormBackedDialogPage ??

Let me know what do you think.

Amad

[oliverhutchison]

now I am using TabbedDialogPage to get my Tabbed forms. But shouldn't there be a CompositeFormPage and then a concrete implementation
TabbedFormPage? I mean its TabbedDialogPage is working for me but I just don't like to use dialog pages in my JPanel even though it just in the name.

Amad,
could you please explain what it is about TabbedDialogPage that you don't like? I'm not sure I understand why you think we need a CompositeFormPage / TabbedFormPage. Perhaps if you could submit some code showing how you are using the form classes I'll catch on.

Right now I have to sort of work indirectly through this TabbedDialogPage and put it on a panel with a button bar (Apply Revert Help).

This is exactly how TabbedDialogPage is intended to be used. Is it simply that you want a class that provides a message area and set of buttons similar to TitledPageApplicationDialog but which can be used as a JPanel rather that a JDialog? This is something which we will certinly be adding support for ASAP.

Ollie

[afida]

could you please explain what it is about TabbedDialogPage that you don't like?

Ollie,
In principal nothing it works form but as Keith had mentioned that it was implemented mainly keeping dialogs in mind. Thats why I think we should seperate this composite page functionality into may be some composite form page. But as I said it could be just this *Dilaog* throwing me off.

Is it simply that you want a class that provides a message area and set of buttons similar to TitledPageApplicationDialog but which can be used as a JPanel rather that a JDialog?

Yes indeed. How soon are we talking about? If not if you can give me some pointers i tihink Iwill figure it out.


Amad

[oliverhutchison]

In principal nothing it works form but as Keith had mentioned that it was implemented mainly keeping dialogs in mind. Thats why I think we should seperate this composite page functionality into may be some composite form page. But as I said it could be just this *Dilaog* throwing me off.

OK. this is what i thought. Don't worry about the *Dialog* there is nothing about DialogPage, TabbedDialogPage etc. that is specific to JDialog. Perhapse we are going to have to make the names clear? Though once we start putting some better documentation in things should get clearer. I hope...


As far as a time frame for having a JPanel based implementation of TitledPageApplicationDialog I can probably do something quite soon (next week). But if you felt adventurous perhaps you should have a go and post your code? If you look in ApplicatonDialog and TitledDialog you should get a fair idea of how to do the implementation.

Ollie

[afida]

Ollie following are two classes that I have created inorder to meet my requirements. Note I don't need messageArea pane for Panel.

1. ApplicationPanel Class

public abstract class ApplicationPanel extends AbstractControlFactory implements Guarded {

    protected final Log logger = LogFactory.getLog(getClass());

    protected static final String DEFAULT_FINISH_KEY = "applyCommand";

    protected static final String DEFAULT_CANCEL_KEY = "revertCommand";

    protected static final String DEFAULT_HELP_KEY = "helpCommand";

    private boolean defaultEnabled = false;

    private ActionCommand finishCommand;

    private ActionCommand cancelCommand;

    private ActionCommand helpCommand;

    private CommandGroup panelCommandGroup;

    /**
     * Should the finish button be enabled by default?
     *
     * @param enabled
     *            true or false
     */
    public void setDefaultEnabled(boolean enabled) {
        this.defaultEnabled = enabled;
    }

    public boolean isEnabled() {
        if (isControlCreated()) {
            return finishCommand.isEnabled();
        }
        else {
            return false;
        }
    }

    public void setEnabled(boolean enabled) {
        setFinishEnabled(enabled);
    }

    protected void setFinishEnabled(boolean enabled) {
        if (isControlCreated()) {
            finishCommand.setEnabled(enabled);
        }
    }

    protected JComponent createControl() {
        initStandardCommands();
        JPanel panel = new JPanel();
        panel.setLayout(new BorderLayout());
        JComponent contentPane = createContentPane();
        GuiStandardUtils.attachBorder(contentPane, Borders.EMPTY_BORDER);
        panel.add(contentPane);
        panel.add(createButtonBar(), BorderLayout.SOUTH);
        return panel;
    }

    private void initStandardCommands() {
        finishCommand = new ActionCommand(getFinishFaceConfigurationKey()) {
            public void doExecuteCommand() {
                try {
                    boolean result = onFinish();
                    if (result) {
                        /** @todo May be some notification */
                    }
                }
                catch (Exception e) {
                    logger.warn("Exception occured executing panel finish command.", e);
                    onFinishException(e);
                }
            }
        };
        finishCommand.setEnabled(defaultEnabled);

        cancelCommand = new ActionCommand(getCancelFaceConfigurationKey()) {
            public void doExecuteCommand() {
                onCancel();
            }
        };

        helpCommand = new ActionCommand(getHelpFaceConfigurationKey()) {
            public void doExecuteCommand() {
                onHelp();
            }
        };

    }

    protected void onFinishException(Exception e) {
        String exceptionMessage;
        if (e instanceof MessageSourceResolvable) {
            exceptionMessage = getMessageSourceAccessor().getMessage((MessageSourceResolvable)e);
        }
        else {
            exceptionMessage = e.getLocalizedMessage();
        }
        if (!StringUtils.hasText(exceptionMessage)) {
            String defaultMessage =
                "Unable to finish; an application exception occured.\nPlease contact your administrator.";
            exceptionMessage = getMessageSourceAccessor().getMessage(
                "applicationPanel.defaultFinishException", defaultMessage);
        }
        JOptionPane.showMessageDialog(getControl(), exceptionMessage, getApplicationName(),
                                      JOptionPane.ERROR_MESSAGE);
    }

    protected String getFinishFaceConfigurationKey() {
        return DEFAULT_FINISH_KEY;
    }

    protected String getCancelFaceConfigurationKey() {
        return DEFAULT_CANCEL_KEY;
    }

    protected String getHelpFaceConfigurationKey() {
        return DEFAULT_HELP_KEY;
    }

    /**
     * Return a standardized row of command buttons, right-justified and all of
     * the same size, with Apply as the default button, and no mnemonics used, as
     * per the Java Look and Feel guidelines.
     */
    protected JComponent createButtonBar() {
        this.panelCommandGroup = CommandGroup.createCommandGroup(null, getCommandGroupMembers());
        JComponent buttonBar = this.panelCommandGroup.createButtonBar();
        GuiStandardUtils.attachBorder(buttonBar, Borders.DIALOG_BORDER);
        return buttonBar;
    }

    protected ActionCommand getFinishCommand() {
        return finishCommand;
    }

    protected ActionCommand getCancelCommand() {
        return cancelCommand;
    }

    protected ActionCommand getHelpCommand() {
        return helpCommand;
    }

    /**
     * Template getter method to return the commands to populate the panel
     * button bar.
     *
     * @return The array of commands (may also be a separator or glue identifier)
     */
    protected Object[] getCommandGroupMembers() {
        return new AbstractCommand[] {
            getFinishCommand(), getCancelCommand(), getHelpCommand()};
    }

    protected void onHelp() {

    }

    /**
     * Template lifecycle method invoked after the dialog control is
     * initialized.
     */
    protected void onInitialized() {
    }

    /**
     * Return the GUI which allows the user to manipulate the business objects
     * related to this panel; this GUI will be placed above the <code>OK</code>
     * and <code>Cancel</code> buttons, in a standard manner.
     */
    protected abstract JComponent createContentPane&#40;&#41;;

    /**
     * Request invocation of the action taken when the user hits the
     * <code>Apply</code> &#40;finish&#41; button.
     *
     * @return true if action completed succesfully; false otherwise.
     */
    protected abstract boolean onFinish&#40;&#41;;

    /**
     * Request invocation of the action taken when the user hits the
     * <code>Cancel</code> &#40;cancel&#41; button.
     *
     */
    protected abstract void onCancel&#40;&#41;;
&#125;

2. PageApplicationPanel Class

public abstract class PageApplictionPanel extends ApplicationPanel implements
    PropertyChangeListener {

    private DialogPage dialogPage;

    public PageApplictionPanel(DialogPage dialogPage) {
        super();
        setDialogPage(dialogPage);
    }

    protected DialogPage getDialogPage() {
        return dialogPage;
    }

    private void setDialogPage(DialogPage dialogPage) {
        this.dialogPage = dialogPage;
    }

    protected JComponent createContentPane() {
        dialogPage.addPropertyChangeListener(this);
        return dialogPage.getControl();
    }

    public void propertyChange(PropertyChangeEvent e) {
        if (DialogPage.PAGE_COMPLETE_PROPERTY.equals(e.getPropertyName())) {
            setEnabled(dialogPage.isPageComplete());
        }
    }

Usage :

        PageApplictionPanel pageApplictionPanel = new PageApplictionPanel(tabbedPage) {
            protected boolean onFinish() {
                globalUserFormModel.commit();
                return true;
            }

            protected void onCancel() {
                globalUserFormModel.revert(); // Note : this doesn't currently work If I have two list boxes and I am copying from one (avilable) to (selected) other..
            }
        };

Only problem I have now is from Keith's class (above pasted) there is no way of reverting since we are adding value to list directly on Add action. There is some BufferedList stuff, I wonder if that can help me here.? Anyone?

Amad

[oliverhutchison]

Only problem I have now is from Keith's class (above pasted) there is no way of reverting since we are adding value to list directly on Add action. There is some BufferedList stuff, I wonder if that can help me here.? Anyone?

That's a bug Amad thanks for spotting it. I seems that BufferedCollectionValueModel was not doing the revert. I've fixed and added a test in CVS.,