components/visual-panels/core/src/java/util/com/oracle/solaris/vp/util/swing/ReplacingStackPanel.java
changeset 3553 f1d133b09a8c
parent 3552 077ebe3d0d24
child 3554 ef58713bafc4
equal deleted inserted replaced
3552:077ebe3d0d24 3553:f1d133b09a8c
     1 /*
       
     2  * CDDL HEADER START
       
     3  *
       
     4  * The contents of this file are subject to the terms of the
       
     5  * Common Development and Distribution License (the "License").
       
     6  * You may not use this file except in compliance with the License.
       
     7  *
       
     8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
       
     9  * or http://www.opensolaris.org/os/licensing.
       
    10  * See the License for the specific language governing permissions
       
    11  * and limitations under the License.
       
    12  *
       
    13  * When distributing Covered Code, include this CDDL HEADER in each
       
    14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
       
    15  * If applicable, add the following below this CDDL HEADER, with the
       
    16  * fields enclosed by brackets "[]" replaced with your own identifying
       
    17  * information: Portions Copyright [yyyy] [name of copyright owner]
       
    18  *
       
    19  * CDDL HEADER END
       
    20  */
       
    21 
       
    22 /*
       
    23  * Copyright (c) 2009, 2012, Oracle and/or its affiliates. All rights reserved.
       
    24  */
       
    25 
       
    26 package com.oracle.solaris.vp.util.swing;
       
    27 
       
    28 import java.awt.*;
       
    29 import java.util.NoSuchElementException;
       
    30 import javax.swing.JPanel;
       
    31 import com.oracle.solaris.vp.util.misc.*;
       
    32 
       
    33 @SuppressWarnings({"serial"})
       
    34 public class ReplacingStackPanel extends JPanel implements Stackable<Component>
       
    35 {
       
    36     //
       
    37     // Instance data
       
    38     //
       
    39 
       
    40     private StackList<Component> components = new StackList<Component>();
       
    41 
       
    42     //
       
    43     // Constructors
       
    44     //
       
    45 
       
    46     public ReplacingStackPanel() {
       
    47 	super(new BorderLayout());
       
    48 	setOpaque(false);
       
    49     }
       
    50 
       
    51     //
       
    52     // Stackable methods
       
    53     //
       
    54 
       
    55     /**
       
    56      * Removes all components from this {@code ReplacingStackPanel}.
       
    57      */
       
    58     @Override
       
    59     public void clear() {
       
    60 	components.clear();
       
    61 	removeAll();
       
    62     }
       
    63 
       
    64     @Override
       
    65     public int getCount() {
       
    66 	return components.getCount();
       
    67     }
       
    68 
       
    69     /**
       
    70      * Returns the top-most {@code Component} from this {@code
       
    71      * ReplacingStackPanel}, or {@code null} if there are no {@code Component}s
       
    72      * in this {@code ReplacingStackPanel}
       
    73      */
       
    74     @Override
       
    75     public Component peek() {
       
    76 	try {
       
    77 	    return peekOrErr();
       
    78 	} catch (NoSuchElementException e) {
       
    79 	    return null;
       
    80 	}
       
    81     }
       
    82 
       
    83     /**
       
    84      * Returns the top-most {@code Component} from this {@code
       
    85      * ReplacingStackPanel}.
       
    86      *
       
    87      * @exception   NoSuchElementException
       
    88      *		    if there are no {@code Component}s in this {@code
       
    89      *		    ReplacingStackPanel}
       
    90      */
       
    91     @Override
       
    92     public Component peekOrErr() {
       
    93 	return components.peekOrErr();
       
    94     }
       
    95 
       
    96     @Override
       
    97     public Component peekOrErr(int n) {
       
    98 	return components.peekOrErr(n);
       
    99     }
       
   100 
       
   101     /**
       
   102      * Removes the top-most {@code Component} from this {@code
       
   103      * ReplacingStackPanel}.
       
   104      *
       
   105      * @return	    the removed {@code Component}
       
   106      *
       
   107      * @exception   NoSuchElementException
       
   108      *		    if there are no {@code Component}s in this {@code
       
   109      *		    ReplacingStackPanel}
       
   110      */
       
   111     @Override
       
   112     public Component pop() {
       
   113 	Component c = components.pop();
       
   114 	removeAll();
       
   115 
       
   116 	try {
       
   117 	    add(peekOrErr(), BorderLayout.CENTER);
       
   118 	} catch (NoSuchElementException ignore) {
       
   119 	}
       
   120 
       
   121 	revalidate();
       
   122 	repaint();
       
   123 
       
   124 	return c;
       
   125     }
       
   126 
       
   127     /**
       
   128      * Adds the given {@code Component} to the top of the {@code Component}
       
   129      * stack.
       
   130      */
       
   131     @Override
       
   132     public void push(Component c) {
       
   133 	removeAll();
       
   134 	add(c, BorderLayout.CENTER);
       
   135 	components.push(c);
       
   136 	revalidate();
       
   137 	repaint();
       
   138     }
       
   139 }