Java/Swing Components/Data Binding Master Slave
Содержание
- 1 Builds a user interface for managing Albums using a table to display
- 2 Demonstrates a hand-made way how to connect a master list with a bound details view
- 3 Demonstrates how to connect a master list with a copying details view
- 4 How to connect a master list with a bound details view
- 5 How to defer updates of a details view after selecting an element in a master list
Builds a user interface for managing Albums using a table to display
<source lang="java">
/*
* Copyright (c) 2002-2005 JGoodies Karsten Lentzsch. All Rights Reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * o Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. * * o Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * * o Neither the name of JGoodies Karsten Lentzsch nor the names of * its contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
package com.jgoodies.binding.tutorial.manager; import java.util.List; import javax.swing.*; import com.jgoodies.binding.adapter.SingleListSelectionAdapter; import com.jgoodies.binding.tutorial.Album; import com.jgoodies.binding.tutorial.TutorialUtils; import com.jgoodies.forms.builder.PanelBuilder; import com.jgoodies.forms.factories.ButtonBarFactory; import com.jgoodies.forms.layout.CellConstraints; import com.jgoodies.forms.layout.FormLayout; /**
* Builds a user interface for managing Albums using a table to display * the Albums and buttons to add, edit, and delete the selected album. * The models and Actions are provided by an underlying AlbumManagerModel. * * @author Karsten Lentzsch * @version $Revision: 1.5 $ * * @see AlbumManagerModel * @see com.jgoodies.binding.PresentationModel */
public class AlbumManagerExample {
/**
* Provides a list of Albums with selection and Action
* for operating on the managed Albums.
*/
private final AlbumManagerModel albumManagerModel;
private JTable albumTable;
private JButton newButton;
private JButton editButton;
private JButton deleteButton;
// Launching **************************************************************
public static void main(String[] args) {
try {
UIManager.setLookAndFeel("com.jgoodies.looks.plastic.PlasticXPLookAndFeel");
} catch (Exception e) {
// Likely PlasticXP is not in the class path; ignore.
}
JFrame frame = new JFrame();
frame.setTitle("Binding Tutorial :: Album Manager");
frame.setDefaultCloseOperation(WindowConstants.EXIT_ON_CLOSE);
JComponent panel = new AlbumManagerExample().build();
frame.getContentPane().add(panel);
frame.pack();
TutorialUtils.locateOnScreenCenter(frame);
frame.setVisible(true);
}
// Instance Creation ******************************************************
/**
* Constructs a list editor using a example album list.
*/
public AlbumManagerExample() {
this(Album.ALBUMS);
}
/**
* Constructs a list editor for editing the given list of albums.
*
* @param albums the list of albums to edit
*/
public AlbumManagerExample(List albums) {
this.albumManagerModel = new AlbumManagerModel(new AlbumManager(albums));
}
// Component Creation and Initialization **********************************
/**
* Creates and intializes the UI components.
*/
private void initComponents() {
albumTable = new JTable();
albumTable.setModel(TutorialUtils.createAlbumTableModel(
albumManagerModel.getAlbumSelection()));
albumTable.setSelectionModel(
new SingleListSelectionAdapter(
albumManagerModel.getAlbumSelection().getSelectionIndexHolder()));
newButton = new JButton(albumManagerModel.getNewAction());
editButton = new JButton(albumManagerModel.getEditAction());
deleteButton = new JButton(albumManagerModel.getDeleteAction());
}
private void initEventHandling() {
albumTable.addMouseListener(albumManagerModel.getDoubleClickHandler());
}
// Building ***************************************************************
/**
* Builds the pane.
*
* @return the built panel
*/
public JComponent build() {
initComponents();
initEventHandling();
FormLayout layout = new FormLayout(
"fill:250dlu:grow",
"p, 1dlu, fill:200dlu, 6dlu, p");
PanelBuilder builder = new PanelBuilder(layout);
builder.setDefaultDialogBorder();
CellConstraints cc = new CellConstraints();
builder.addTitle("Albums", cc.xy(1, 1));
builder.add(new JScrollPane(albumTable), cc.xy(1, 3));
builder.add(buildButtonBar(), cc.xy(1, 5));
return builder.getPanel();
}
private JComponent buildButtonBar() {
return ButtonBarFactory.buildLeftAlignedBar(
newButton,
editButton,
deleteButton);
}
}
</source>
Demonstrates a hand-made way how to connect a master list with a bound details view
<source lang="java">
/*
* Copyright (c) 2002-2005 JGoodies Karsten Lentzsch. All Rights Reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * o Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. * * o Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * * o Neither the name of JGoodies Karsten Lentzsch nor the names of * its contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
package com.jgoodies.binding.tutorial.basics; import java.util.List; import javax.swing.*; import javax.swing.event.ListSelectionEvent; import javax.swing.event.ListSelectionListener; import javax.swing.text.JTextComponent; import com.jgoodies.binding.PresentationModel; import com.jgoodies.binding.adapter.BasicComponentFactory; import com.jgoodies.binding.tutorial.Album; import com.jgoodies.binding.tutorial.TutorialUtils; import com.jgoodies.binding.value.ConverterFactory; import com.jgoodies.binding.value.ValueHolder; import com.jgoodies.forms.builder.PanelBuilder; import com.jgoodies.forms.factories.ButtonBarFactory; import com.jgoodies.forms.layout.CellConstraints; import com.jgoodies.forms.layout.FormLayout; /**
* Demonstrates a "hand-made" way how to connect a master list with a bound * details view. It builds a JList of Albums with an attached details panel * that presents the current Album selection. The details panel"s components* are bound to the domain using ValueModels returned by a PresentationModel.
* * This example handles selection changes with a custom ListSelectionListener, * the AlbumSelectionHandler, that sets the JList"s selected values as new * bean of the details PresentationModel. A simpler means to achieve the same * effect is demonstrated by the MasterDetailsSelectionInListExample that uses * the SelectionInList as bean channel for the details PresentationModel.<p> * * Another variant of this example is the MasterDetailsCopyingExample * that copies the details data on list selection changes, instead of binding * the details UI components to the details PresentationModel"s ValueModels. * * @author Karsten Lentzsch * @version $Revision: 1.6 $ * * @see com.jgoodies.binding.PresentationModel * @see com.jgoodies.binding.tutorial.basics.MasterDetailsCopyingExample * @see com.jgoodies.binding.tutorial.basics.MasterDetailsSelectionInListExample */ public class MasterDetailsBoundExample { /** * The Albums displayed in the master list. */ private final List albums; /** * Holds the edited Album and vends ValueModels that adapt Album properties. */ private final PresentationModel detailsModel; private JList albumsList; private JTextComponent titleField; private JTextComponent artistField; private JTextComponent classicalField; private JTextComponent composerField; private JButton closeButton; // Launching ************************************************************** public static void main(String[] args) { try { UIManager.setLookAndFeel("com.jgoodies.looks.plastic.PlasticXPLookAndFeel"); } catch (Exception e) { // Likely PlasticXP is not in the class path; ignore. } JFrame frame = new JFrame(); frame.setTitle("Binding Tutorial :: Master/Details (Bound)"); frame.setDefaultCloseOperation(WindowConstants.EXIT_ON_CLOSE); JComponent panel = new MasterDetailsBoundExample().build(); frame.getContentPane().add(panel); frame.pack(); TutorialUtils.locateOnScreenCenter(frame); frame.setVisible(true); } // Instance Creation ****************************************************** /** * Constructs a list editor using a example Album list. */ public MasterDetailsBoundExample() { this(Album.ALBUMS); } /** * Constructs a list editor for editing the given list of Albums. * * @param albums the list of Albums to edit */ public MasterDetailsBoundExample(List albums) { this.albums = albums; detailsModel = new PresentationModel(new ValueHolder(null)); } // Component Creation and Initialization ********************************** /** * Creates, binds, and configures the UI components. * All components in the details view are read-only.<p> * * The coding style used here is based on standard Swing components. * Therefore we can create and bind the components in one step. * And that"s the purpose of the BasicComponentFactory class.<p> * * If you need to bind custom components, for example MyTextField, * MyCheckBox, MyComboBox, you can use the more basic Bindings class. * The code would then read:
* titleField = new MyTextField();
* Bindings.bind(titleField,
* detailsModel.getModel(Album.PROPERTYNAME_TITLE));
* <p>
*
* I strongly recommend to use either the BasicComponentFactory or
* the Bindings class. These classes hide details of the binding.
* So you better not write the following code:
* titleField = new JTextField();
* titleField.setDocument(new DocumentAdapter(
* detailsModel.getModel(Album.PROPERTYNAME_TITLE)));
*
*/
private void initComponents() {
albumsList = new JList(albums.toArray());
albumsList.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
albumsList.setCellRenderer(TutorialUtils.createAlbumListCellRenderer());
titleField = BasicComponentFactory.createTextField(
detailsModel.getModel(Album.PROPERTYNAME_TITLE));
titleField.setEditable(false);
artistField = BasicComponentFactory.createTextField(
detailsModel.getModel(Album.PROPERTYNAME_ARTIST));
artistField.setEditable(false);
classicalField = BasicComponentFactory.createTextField(
ConverterFactory.createBooleanToStringConverter(
detailsModel.getModel(Album.PROPERTYNAME_CLASSICAL),
"Yes",
"No"));
classicalField.setEditable(false);
composerField = BasicComponentFactory.createTextField(
detailsModel.getModel(Album.PROPERTYNAME_COMPOSER));
composerField.setEditable(false);
closeButton = new JButton(TutorialUtils.getCloseAction());
}
private void initEventHandling() {
albumsList.addListSelectionListener(new AlbumSelectionHandler());
}
// Building ***************************************************************
/**
* Builds and returns a panel that consists of
* a master list and a details form.
*
* @return the built panel
*/
public JComponent build() {
initComponents();
initEventHandling();
FormLayout layout = new FormLayout(
"right:pref, 3dlu, 150dlu:grow",
"p, 1dlu, p, 9dlu, p, 1dlu, p, 3dlu, p, 3dlu, p, 3dlu, p, 9dlu, p");
PanelBuilder builder = new PanelBuilder(layout);
builder.setDefaultDialogBorder();
CellConstraints cc = new CellConstraints();
builder.addSeparator("Albums", cc.xyw(1, 1, 3));
builder.add(new JScrollPane(
albumsList), cc.xy (3, 3));
builder.addSeparator("Details", cc.xyw(1, 5, 3));
builder.addLabel("Title", cc.xy (1, 7));
builder.add(titleField, cc.xy (3, 7));
builder.addLabel("Artist", cc.xy (1, 9));
builder.add(artistField, cc.xy (3, 9));
builder.addLabel("Classical", cc.xy (1, 11));
builder.add(classicalField, cc.xy (3, 11));
builder.addLabel("Composer", cc.xy (1, 13));
builder.add(composerField, cc.xy (3, 13));
builder.add(buildButtonBar(), cc.xyw(1, 15, 3));
return builder.getPanel();
}
private JComponent buildButtonBar() {
return ButtonBarFactory.buildRightAlignedBar(closeButton);
}
// Event Handling ********************************************************
private class AlbumSelectionHandler implements ListSelectionListener {
public void valueChanged(ListSelectionEvent e) {
if (e.getValueIsAdjusting())
return;
detailsModel.setBean(albumsList.getSelectedValue());
}
}
}
</source>
Demonstrates how to connect a master list with a copying details view
<source lang="java">
/*
* Copyright (c) 2002-2005 JGoodies Karsten Lentzsch. All Rights Reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * o Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. * * o Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * * o Neither the name of JGoodies Karsten Lentzsch nor the names of * its contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
package com.jgoodies.binding.tutorial.basics; import java.util.List; import javax.swing.*; import javax.swing.event.ListSelectionEvent; import javax.swing.event.ListSelectionListener; import javax.swing.text.JTextComponent; import com.jgoodies.binding.tutorial.Album; import com.jgoodies.binding.tutorial.TutorialUtils; import com.jgoodies.forms.builder.PanelBuilder; import com.jgoodies.forms.factories.ButtonBarFactory; import com.jgoodies.forms.layout.CellConstraints; import com.jgoodies.forms.layout.FormLayout; /**
* Demonstrates how to connect a master list with a copying details view. * It builds a JList of Albums with an attached Album details panel * that presents the current Album selection. The details data * is copied back and forth from the domain to the details UI components.<p> * * A bound variant of this example is the MasterDetailsBoundExample * that binds the details UI components to the ValueModels provided * by a details PresentationModel. An even simpler variant is the * MasterDetailsSelectionInListExample that uses the SelectionInList * as bean channel for the details PresentationModel. * * @author Karsten Lentzsch * @version $Revision: 1.6 $ * * @see com.jgoodies.binding.tutorial.basics.MasterDetailsBoundExample * @see com.jgoodies.binding.tutorial.basics.MasterDetailsSelectionInListExample */
public class MasterDetailsCopyingExample {
/**
* The Albums displayed in the overview list.
*/
private final List albums;
/**
* Holds the list selection, which is the currently edited Album.
*/
private Album editedAlbum;
private JList albumsList;
private JTextComponent titleField;
private JTextComponent artistField;
private JTextComponent classicalField;
private JTextComponent composerField;
private JButton closeButton;
// Launching **************************************************************
public static void main(String[] args) {
try {
UIManager.setLookAndFeel("com.jgoodies.looks.plastic.PlasticXPLookAndFeel");
} catch (Exception e) {
// Likely PlasticXP is not in the class path; ignore.
}
JFrame frame = new JFrame();
frame.setTitle("Binding Tutorial :: Master/Details (Copying)");
frame.setDefaultCloseOperation(WindowConstants.EXIT_ON_CLOSE);
JComponent panel = new MasterDetailsCopyingExample().build();
frame.getContentPane().add(panel);
frame.pack();
TutorialUtils.locateOnScreenCenter(frame);
frame.setVisible(true);
}
// Instance Creation ******************************************************
/**
* Constructs a list editor using a example Album list.
*/
public MasterDetailsCopyingExample() {
this(Album.ALBUMS);
}
/**
* Constructs a list editor for editing the given list of Albums.
*
* @param albums the list of Albums to edit
*/
public MasterDetailsCopyingExample(List albums) {
this.albums = albums;
}
// Component Creation and Initialization **********************************
/**
* Creates and intializes the UI components.
* All components in the details view are read-only.
*/
private void initComponents() {
albumsList = new JList(albums.toArray());
albumsList.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
albumsList.setCellRenderer(TutorialUtils.createAlbumListCellRenderer());
titleField = new JTextField();
titleField.setEditable(false);
artistField = new JTextField();
artistField.setEditable(false);
classicalField = new JTextField();
classicalField.setEditable(false);
composerField = new JTextField();
composerField.setEditable(false);
closeButton = new JButton(TutorialUtils.getCloseAction());
}
private void initEventHandling() {
albumsList.addListSelectionListener(new AlbumSelectionListener());
}
// Copying Data Back and Forth ********************************************
/**
* Reads the property values from the edited Album
* and sets them in this editor"s components.
*
* @param album the Album to read property values from
*/
private void updateView(Album album) {
titleField.setText(album.getTitle());
artistField.setText(album.getArtist());
classicalField.setText(album.isClassical() ? "Yes" : "No");
composerField.setText(album.getComposer());
}
// Building ***************************************************************
/**
* Builds and returns a panel that consists of
* a master list and a details form.
*
* @return the built panel
*/
public JComponent build() {
initComponents();
initEventHandling();
FormLayout layout = new FormLayout(
"right:pref, 3dlu, 150dlu:grow",
"p, 1dlu, p, 9dlu, p, 1dlu, p, 3dlu, p, 3dlu, p, 3dlu, p, 9dlu, p");
PanelBuilder builder = new PanelBuilder(layout);
builder.setDefaultDialogBorder();
CellConstraints cc = new CellConstraints();
builder.addSeparator("Albums", cc.xyw(1, 1, 3));
builder.add(new JScrollPane(
albumsList), cc.xy (3, 3));
builder.addSeparator("Details", cc.xyw(1, 5, 3));
builder.addLabel("Title", cc.xy (1, 7));
builder.add(titleField, cc.xy (3, 7));
builder.addLabel("Artist", cc.xy (1, 9));
builder.add(artistField, cc.xy (3, 9));
builder.addLabel("Classical", cc.xy (1, 11));
builder.add(classicalField, cc.xy (3, 11));
builder.addLabel("Composer", cc.xy (1, 13));
builder.add(composerField, cc.xy (3, 13));
builder.add(buildButtonBar(), cc.xyw(1, 15, 3));
return builder.getPanel();
}
private JComponent buildButtonBar() {
return ButtonBarFactory.buildRightAlignedBar(closeButton);
}
// Event Handling *********************************************************
private final class AlbumSelectionListener implements ListSelectionListener {
public void valueChanged(ListSelectionEvent e) {
if (e.getValueIsAdjusting())
return;
// Now set the current selection as edited album.
editedAlbum = (Album) albumsList.getSelectedValue();
// Then copy the album data to the component values.
updateView(editedAlbum);
}
}
}
</source>
How to connect a master list with a bound details view
<source lang="java">
/*
* Copyright (c) 2002-2005 JGoodies Karsten Lentzsch. All Rights Reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * o Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. * * o Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * * o Neither the name of JGoodies Karsten Lentzsch nor the names of * its contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
package com.jgoodies.binding.tutorial.basics; import java.util.List; import javax.swing.*; import javax.swing.text.JTextComponent; import com.jgoodies.binding.PresentationModel; import com.jgoodies.binding.adapter.BasicComponentFactory; import com.jgoodies.binding.list.SelectionInList; import com.jgoodies.binding.tutorial.Album; import com.jgoodies.binding.tutorial.TutorialUtils; import com.jgoodies.binding.value.ConverterFactory; import com.jgoodies.forms.builder.PanelBuilder; import com.jgoodies.forms.factories.ButtonBarFactory; import com.jgoodies.forms.layout.CellConstraints; import com.jgoodies.forms.layout.FormLayout; /**
* Demonstrates an elegant way how to connect a master list with a bound * details view. It builds a JList of Albums with an attached details panel * that presents the current Album selection. The details panel"s components * are bound to the domain using ValueModels returned by a PresentationModel.<p> * * This example does not require a custom ListSelectionListener to handle * selection changes in the list of Albums. Instead it uses the SelectionInList * as bean channel for the details PresentationModel. And so, whenever the * SelectionInList"s selection changes, the details PresentationModel will * automatically update the bean used to display the details.<p> * * In contrast, the MasterDetailsBoundExample uses a ListSelectionListener * to handle selection changes in the Album list. This listener then sets * the current selection as the details PresentationModel"s new bean.<p> * * Another variant of this example is the MasterDetailsDelayedReadExample * that deferres selection changes for a specified delay. This can be useful * if bean changes in the details PresentationModel require time consuming * additional operations, for example a database lookup, a heavy computation, * or a remote access. * * @author Karsten Lentzsch * @version $Revision: 1.7 $ * * @see com.jgoodies.binding.PresentationModel * @see com.jgoodies.binding.tutorial.basics.MasterDetailsBoundExample * @see com.jgoodies.binding.tutorial.extras.MasterDetailsDelayedReadExample */
public class MasterDetailsSelectionInListExample {
/**
* Holds the list of Albums plus a single selection.
*/
private final SelectionInList albumSelection;
/**
* Holds the edited Album and vends ValueModels that adapt Album properties.
*/
private final PresentationModel detailsModel;
private JList albumsList;
private JTextComponent titleField;
private JTextComponent artistField;
private JTextComponent classicalField;
private JTextComponent composerField;
private JButton closeButton;
// Launching **************************************************************
public static void main(String[] args) {
try {
UIManager.setLookAndFeel("com.jgoodies.looks.plastic.PlasticXPLookAndFeel");
} catch (Exception e) {
// Likely PlasticXP is not in the class path; ignore.
}
JFrame frame = new JFrame();
frame.setTitle("Binding Tutorial :: Master/Details (SelectionInList)");
frame.setDefaultCloseOperation(WindowConstants.EXIT_ON_CLOSE);
JComponent panel = new MasterDetailsSelectionInListExample().build();
frame.getContentPane().add(panel);
frame.pack();
TutorialUtils.locateOnScreenCenter(frame);
frame.setVisible(true);
}
// Instance Creation ******************************************************
/**
* Constructs a list editor using a example Album list.
*/
public MasterDetailsSelectionInListExample() {
this(Album.ALBUMS);
}
/**
* Constructs a list editor for editing the given list of Albums.
*
* @param albums the list of Albums to edit
*/
public MasterDetailsSelectionInListExample(List albums) {
this.albumSelection = new SelectionInList(albums);
// The PresentationModel uses the SelectionInList as bean channel.
// In other words, the list"s selection is the adapter"s bean.
detailsModel = new PresentationModel(albumSelection);
// Another way to write the above is:
// detailsModel = new PresentationModel(albumSelection.getSelectionHolder(), true);
}
// Component Creation and Initialization **********************************
/**
* Creates and intializes the UI components.
*/
private void initComponents() {
albumsList = BasicComponentFactory.createList(
albumSelection,
TutorialUtils.createAlbumListCellRenderer());
titleField = BasicComponentFactory.createTextField(
detailsModel.getModel(Album.PROPERTYNAME_TITLE));
titleField.setEditable(false);
artistField = BasicComponentFactory.createTextField(
detailsModel.getModel(Album.PROPERTYNAME_ARTIST));
artistField.setEditable(false);
classicalField = BasicComponentFactory.createTextField(
ConverterFactory.createBooleanToStringConverter(
detailsModel.getModel(Album.PROPERTYNAME_CLASSICAL),
"Yes",
"No"));
classicalField.setEditable(false);
composerField = BasicComponentFactory.createTextField(
detailsModel.getModel(Album.PROPERTYNAME_COMPOSER));
composerField.setEditable(false);
closeButton = new JButton(TutorialUtils.getCloseAction());
}
// Building ***************************************************************
/**
* Builds and returns a panel that consists of
* a master list and a details form.
*
* @return the built panel
*/
public JComponent build() {
initComponents();
FormLayout layout = new FormLayout(
"right:pref, 3dlu, 150dlu:grow",
"p, 1dlu, p, 9dlu, p, 1dlu, p, 3dlu, p, 3dlu, p, 3dlu, p, 9dlu, p");
PanelBuilder builder = new PanelBuilder(layout);
builder.setDefaultDialogBorder();
CellConstraints cc = new CellConstraints();
builder.addSeparator("Albums", cc.xyw(1, 1, 3));
builder.add(new JScrollPane(
albumsList), cc.xy (3, 3));
builder.addSeparator("Details", cc.xyw(1, 5, 3));
builder.addLabel("Title", cc.xy (1, 7));
builder.add(titleField, cc.xy (3, 7));
builder.addLabel("Artist", cc.xy (1, 9));
builder.add(artistField, cc.xy (3, 9));
builder.addLabel("Classical", cc.xy (1, 11));
builder.add(classicalField, cc.xy (3, 11));
builder.addLabel("Composer", cc.xy (1, 13));
builder.add(composerField, cc.xy (3, 13));
builder.add(buildButtonBar(), cc.xyw(1, 15, 3));
return builder.getPanel();
}
private JComponent buildButtonBar() {
return ButtonBarFactory.buildRightAlignedBar(closeButton);
}
}
</source>
How to defer updates of a details view after selecting an element in a master list
<source lang="java">
/*
* Copyright (c) 2002-2005 JGoodies Karsten Lentzsch. All Rights Reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * o Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. * * o Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * * o Neither the name of JGoodies Karsten Lentzsch nor the names of * its contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
package com.jgoodies.binding.tutorial.extras; import java.util.List; import javax.swing.*; import javax.swing.text.JTextComponent; import com.jgoodies.binding.PresentationModel; import com.jgoodies.binding.adapter.BasicComponentFactory; import com.jgoodies.binding.extras.DelayedReadValueModel; import com.jgoodies.binding.list.SelectionInList; import com.jgoodies.binding.tutorial.Album; import com.jgoodies.binding.tutorial.TutorialUtils; import com.jgoodies.binding.value.ConverterFactory; import com.jgoodies.forms.builder.PanelBuilder; import com.jgoodies.forms.factories.ButtonBarFactory; import com.jgoodies.forms.layout.CellConstraints; import com.jgoodies.forms.layout.FormLayout; /**
* Demonstrates an elegant means how to defer updates of a details view * after selecting an element in a master list. This can be useful * if changing the details requires time consuming additional operations, * for example a database lookup, a heavy computation, or a remote access.<p> * * This class builds a JList of Albums with an attached details panel * that presents the current Album selection. The details panel"s components * are bound to the domain using ValueModels returned by a PresentationModel. * The master JList is bound to a SelectionInList that holds the list of Albums * and the currently selected Album. The SelectionInList is used as bean channel * for the details PresentationModel. And so, whenever the SelectionInList"s * selection changes, the details PresentationModel will automatically update * the bean used to display the details.<p> * * This example implements the deferred details update by using a delayed * version of the SelectionInList as the presentation model"s bean channel. * Changes in the SelectionInList"s selecion are held back for a specified delay * before the selection becomes the presentation model"s new bean. * * @author Karsten Lentzsch * @version $Revision: 1.3 $ * * @see #initComponents() * @see DelayedReadValueModel * @see com.jgoodies.binding.PresentationModel * @see com.jgoodies.binding.tutorial.basics.MasterDetailsSelectionInListExample */
public class MasterDetailsDelayedReadExample {
/**
* The default in milliseconds to wait before a selection change
* shall be forwarded to the delayed details presentation model.
*/
private static final int DEFAULT_DELAY = 1000;
/**
* Holds the list of Albums plus a single selection.
*/
private final SelectionInList albumSelection;
/**
* Holds the selected Album and vends ValueModels that adapt Album properties.
*/
private final PresentationModel detailsModel;
private JList albumsList;
private JTextComponent titleField;
private JTextComponent artistField;
private JTextComponent classicalField;
private JTextComponent composerField;
private JButton closeButton;
// Launching **************************************************************
public static void main(String[] args) {
try {
UIManager.setLookAndFeel("com.jgoodies.looks.plastic.PlasticXPLookAndFeel");
} catch (Exception e) {
// Likely PlasticXP is not in the class path; ignore.
}
JFrame frame = new JFrame();
frame.setTitle("Binding Tutorial :: Master/Details (Delayed)");
frame.setDefaultCloseOperation(WindowConstants.EXIT_ON_CLOSE);
JComponent panel = new MasterDetailsDelayedReadExample().build();
frame.getContentPane().add(panel);
frame.pack();
TutorialUtils.locateOnScreenCenter(frame);
frame.setVisible(true);
}
// Instance Creation ******************************************************
/**
* Constructs a delayed list editor using an example Album list
* and the default delay.
*/
public MasterDetailsDelayedReadExample() {
this(Album.ALBUMS);
}
/**
* Constructs a delayed list editor for editing the given list of Albums
* using the default delay.
*
* @param albums the list of Albums to edit
*/
public MasterDetailsDelayedReadExample(List albums) {
this(albums, DEFAULT_DELAY);
}
/**
* Constructs a list editor for editing the given list of Albums
* using the specified delay.
*
* @param albums the list of Albums to edit
* @param delay the milliseconds to wait before the album selection
* is forwarded to the SelectionInList
*/
public MasterDetailsDelayedReadExample(List albums, int delay) {
this.albumSelection = new SelectionInList(albums);
// Uses the delayed SelectionInList as PresentationModel"s bean channel.
// The SelectionInList is wrapped so that selection updates will be
// deferred for the specified delay. In other words, the list"s
// selection becomes the Presentation Model"s new bean - after a delay.
detailsModel = new PresentationModel(
new DelayedReadValueModel(albumSelection, delay));
}
// Component Creation and Initialization **********************************
/**
* Creates and intializes the UI components. The JList used to present
* the Album list is bound directly to the SelectionInList which
* implements the required ListModel interface. Even the JList"s
* selection model is bound directly bound the the SelectionInList"s
* selection index holder. It"s just that the presentation model"s
* bean channel is not the selection, but a delayed selection.<p>
*
* If the user selects an element in the Album JList, the selection model
* changes immediately. It"s just that the bean of the detailsModel will
* be set a bit later, which in turn holds back details change a bit.
* See the constructor to study how the master SelectionInList is wrapped
* by a DelayedReadValueModel to hold back selection changes for a limited
* amount of time.
*/
private void initComponents() {
albumsList = BasicComponentFactory.createList(
albumSelection,
TutorialUtils.createAlbumListCellRenderer());
titleField = BasicComponentFactory.createTextField(
detailsModel.getModel(Album.PROPERTYNAME_TITLE));
titleField.setEditable(false);
artistField = BasicComponentFactory.createTextField(
detailsModel.getModel(Album.PROPERTYNAME_ARTIST));
artistField.setEditable(false);
classicalField = BasicComponentFactory.createTextField(
ConverterFactory.createBooleanToStringConverter(
detailsModel.getModel(Album.PROPERTYNAME_CLASSICAL),
"Yes",
"No"));
classicalField.setEditable(false);
composerField = BasicComponentFactory.createTextField(
detailsModel.getModel(Album.PROPERTYNAME_COMPOSER));
composerField.setEditable(false);
closeButton = new JButton(TutorialUtils.getCloseAction());
}
// Building ***************************************************************
/**
* Builds and returns a panel that consists of
* a master list and a details form.
*
* @return the built panel
*/
public JComponent build() {
initComponents();
FormLayout layout = new FormLayout(
"right:pref, 3dlu, 150dlu:grow",
"p, 1dlu, p, 9dlu, p, 1dlu, p, 3dlu, p, 3dlu, p, 3dlu, p, 9dlu, p");
PanelBuilder builder = new PanelBuilder(layout);
builder.setDefaultDialogBorder();
CellConstraints cc = new CellConstraints();
builder.addSeparator("Albums", cc.xyw(1, 1, 3));
builder.add(new JScrollPane(
albumsList), cc.xy (3, 3));
builder.addSeparator("Delayed Details",
cc.xyw(1, 5, 3));
builder.addLabel("Title", cc.xy (1, 7));
builder.add(titleField, cc.xy (3, 7));
builder.addLabel("Artist", cc.xy (1, 9));
builder.add(artistField, cc.xy (3, 9));
builder.addLabel("Classical", cc.xy (1, 11));
builder.add(classicalField, cc.xy (3, 11));
builder.addLabel("Composer", cc.xy (1, 13));
builder.add(composerField, cc.xy (3, 13));
builder.add(buildButtonBar(), cc.xyw(1, 15, 3));
return builder.getPanel();
}
private JComponent buildButtonBar() {
return ButtonBarFactory.buildRightAlignedBar(closeButton);
}
}
</source>
