Class MultiplePageDialog

Method Details

• createBannerPanel

  public JComponent createBannerPanel()

  Implements the method in StandardDialog. You can override this method to create a BannerPanel.

  Specified by:

  createBannerPanel in class StandardDialog

  Returns:

  the BannerPanel

• createContentPanel

  public JComponent createContentPanel()

  Implements the method in StandardDialog. You can override this method to create a ContentPanel. By default, a JPanel with BorderLayout is created. IndexPanel is added to WEST and PagesPanel is added to CENTER.

  Specified by:

  createContentPanel in class StandardDialog

  Returns:

  the ContentPanel

• setupContentPanel

  protected JComponent setupContentPanel(JComponent indexPanel, JComponent pagesPanel)

  Setups the content panel. It will use the index panel and the pages panel created earlier and put it into another panel.

  Parameters:

  indexPanel - the index panel. It has the nagivation control to control which page to show.

  pagesPanel - the pages panel. It contains all the pages of this dialog.

  Returns:

  the panel that contains both index panel and pages panel.

• createButtonPanel

  public ButtonPanel createButtonPanel()

  Creates the button panel. It has three buttons - OK, Cancel and Apply. If you want to create your own button panel, just override this method.

  Specified by:

  createButtonPanel in class StandardDialog

  Returns:

  button panel

  See Also:

  • ButtonPanel

• getOkButton

  public JButton getOkButton()

  Gets the OK Button only if you didn't override the createButtonPanel() and remove the OK button.

  Returns:

  the OK Button

• getCancelButton

  public JButton getCancelButton()

  Gets the cancel button. only if you didn't override the createButtonPanel() and remove the cancel button.

  Returns:

  the cancel button.

• getApplyButton

  public JButton getApplyButton()

  Gets the apply button. only if you didn't override the createButtonPanel() and remove the apply button.

  Returns:

  the apply button.

• createPagesPanel

  protected JComponent createPagesPanel()

  Creates the pages panel. If it's TAB_STYLE, a tabbed pane will be created. If it's any other styles, a JPanel with CardLayout will be created.

  Returns:

  a panel containing all the pages.

• createTabbedPane

  protected JTabbedPane createTabbedPane()

  Creates the JTabbedPane used by TAB_STYLE dialog.

  Returns:

  a JTabbedPane

• createIndexPanel

  public JComponent createIndexPanel()

  Creates the index panel based on the style.

  Returns:

  the index panel.

• setPageList

  public void setPageList(PageList pageList)

  Sets the page list of this dialog. User must call this method before the dialog is set visible.

  Parameters:

  pageList - the page list

• getPageList

  public PageList getPageList()

  Gets the page list of this dialog.

  Returns:

  the page list.

• getCurrentPage

  public AbstractDialogPage getCurrentPage()

  Gets the current selected page.

  Returns:

  the current selected page.

• setCurrentPage

  protected void setCurrentPage(String pageTitle)

• setCurrentPage

  protected void setCurrentPage(AbstractDialogPage currentPage)

• setCurrentPage

  protected void setCurrentPage(AbstractDialogPage currentPage, Object source)

• showCurrentPage

  protected void showCurrentPage(AbstractDialogPage currentPage)

  Displays the current page. If it is TAB_STYLE, this method will simply select the tab that has the current page. If it is any of the other styles, this method will show the page that is already added in a CardLayout in createPagePanel method.

  Parameters:

  currentPage - the current page

• createTree

  protected JTree createTree(DefaultMutableTreeNode root)

  Creates tree that is used in TREE_STYLE dialog's index panel. Below is the code we used. If you just want to have a different cell renderer, you can just call setTreeCellRenderer(javax.swing.tree.TreeCellRenderer) to set a new one.

  
   UIManager.put("Tree.hash", Color.white);
   return new JTree(root);
   

  Parameters:

  root - the root of the tree

  Returns:

  tree the created JTree instance

• configureTree

  protected void configureTree(JTree tree)

  Configure the JTree used in TREE_STYLE dialog. Subclass can override this method to configure the JTree to the way you want. Below is the default implementation of this method.

   tree.setToggleClickCount(1);
   tree.setCellRenderer(createTreeCellRenderer());
   tree.setRootVisible(false);
   tree.setShowsRootHandles(false);
   tree.addTreeSelectionListener(new TreeSelectionListener() {
       public void valueChanged(TreeSelectionEvent e) {
           if (tree.getSelectionPath() == null) {
               return;
           }
   
  
           DefaultMutableTreeNode treeNode = (DefaultMutableTreeNode)
   tree.getSelectionPath().getLastPathComponent();
           // comment this while block if you want the parent page shows its own page instead
   of
   showing its first child page.
           while (!treeNode.isLeaf()) {
               final DefaultMutableTreeNode tn = treeNode;
               Runnable runnable = new Runnable() {
                   public void run() {
                       tree.expandPath(new TreePath(tn.getPath()));
                   }
               };
               SwingUtilities.invokeLater(runnable);
               treeNode = (DefaultMutableTreeNode) treeNode.getChildAt(0);
           }
   
  
           if (treeNode != null) {
               Object userObject = treeNode.getUserObject();
               if (userObject instanceof AbstractDialogPage) {
                   setCurrentPage((AbstractDialogPage) userObject, tree);
               }
           }
       }
   });
   

  Parameters:

  tree - the tree to configure

• createTreeNode

  protected MutableTreeNode createTreeNode(AbstractDialogPage dialogPage)

  Create tree node for TREE_STYLE pages.

  Parameters:

  dialogPage - the corresponding dialog page.

  Returns:

  the tree node.

• createList

  protected JList createList(DefaultListModel listModel)

  Creates list that is used in LIST_STYLE dialog's index panel. Below is the code we used. If you just want to have a different cell renderer, you can just call setListCellRenderer(javax.swing.ListCellRenderer) to set a new one.

  
   JList list = new JList(listModel);
   list.setCellRenderer(createListCellRenderer());
   return list;
   

  Parameters:

  listModel - the list model

  Returns:

  list.

• createIconPanel

  protected JComponent createIconPanel()

  Creates the panel that contains several icons. Each icon represents for a page. This is only used for ICON_STYLE.

  Returns:

  a panel that contains several icons.

• createIconButtonPanel

  protected ButtonPanel createIconButtonPanel()

  Creates the ButtonPanel used by IconPanel. By default, we create it using new ScrollableButtonPanel(SwingConstants.TOP, ButtonPanel.SAME_SIZE).

  Returns:

  the ButtonPanel.

• createIconButton

  protected JideButton createIconButton(String title, Icon icon)

  Creates the button for each icon.

  Parameters:

  title - the button title

  icon - the button icon

  Returns:

  the button

• getStyle

  public int getStyle()

  Gets the style of this dialog.

  Returns:

  the style. It can be TAB_STYLE, ICON_STYLE, LIST_STYLE or TREE_STYLE.

• setStyle

  public void setStyle(int style)

  Sets the style of this dialog. This class doesn't support change style on fly. You can only change style before the dialog is set to visible.

  Parameters:

  style - It must be one of the following: TAB_STYLE, ICON_STYLE, LIST_STYLE or TREE_STYLE.

• getIndexPanel

  public JComponent getIndexPanel()

  Gets the index panel.

  Returns:

  the index panel.

• getPagesPanel

  public JComponent getPagesPanel()

  Gets the pages panel.

  Returns:

  the pages panel.

• getTreeCellRenderer

  protected TreeCellRenderer getTreeCellRenderer()

  Gets the cell renderer used by the tree. It's used only when the style is TREE_STYLE.

  Returns:

  the tree cell renderer.

• setTreeCellRenderer

  public void setTreeCellRenderer(TreeCellRenderer treeCellRenderer)

  Sets the tree cell renderer that will be used by JTree when the style is TREE_STYLE.

  Parameters:

  treeCellRenderer - the tree cell renderer

• getListCellRenderer

  protected ListCellRenderer getListCellRenderer()

  Gets the cell renderer used by the list. It's used only when the style is LIST_STYLE.

  Returns:

  the list cell renderer.

• setListCellRenderer

  public void setListCellRenderer(ListCellRenderer listCellRenderer)

  Sets the list cell renderer that will be used by JList when the style is LIST_STYLE.

  Parameters:

  listCellRenderer - the list cell renderer

• createListCellRenderer

  protected ListCellRenderer createListCellRenderer()

  Creates a list cell renderer used by list in LIST_STYLE dialog's index panel.

  Returns:

  the list cell renderer.

• createTreeCellRenderer

  protected TreeCellRenderer createTreeCellRenderer()

  Creates the tree cell renderer used by tree in TREE_STYLE dialog's index panel.

  Returns:

  the tree cell renderer.

• getInitialPageTitle

  public String getInitialPageTitle()

  Gets the initial page title. Initial page is the page that will be selected when the dialog is just opened. Please note the title is the full title. In most case it's just the title of the page. Only in TREE_STYLE, it should be a list of titles that concats with '.'.

  Returns:

  the initial page title.

• setInitialPageTitle

  public void setInitialPageTitle(String initialPageTitle)

  Sets the initial page title. Initial page is the page that will be selected when the dialog.

  Parameters:

  initialPageTitle - the initial page title