Package org.cytoscape.util.swing

Class BasicCollapsiblePanel

  • All Implemented Interfaces:
    ImageObserver, MenuContainer, Serializable, Accessible
    public class BasicCollapsiblePanel
extends JPanel
    A user-triggered collapsible panel containing the component (trigger) in the titled border
    See Also:
    Serialized Form

    Module: swing-util-api

    To use this in your app, include the following dependency in your POM:

    <dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>swing-util-api</artifactId>
</dependency>

    • Constructor Detail

      • BasicCollapsiblePanel

        public BasicCollapsiblePanel​(JRadioButton component)
        Constructor for an option button controlled collapsible panel. This is useful when a group of options each have unique sub contents. The radio buttons should be created, grouped, and then used to construct their own collapsible panels. This way choosing a different option in the same option group will collapse all unselected options. Expanded panels draw a border around the contents and through the radio button in the fashion of a titled border.
        Parameters:
        component - Radio button that expands and collapses the panel based on if it is selected or not

      • BasicCollapsiblePanel

        public BasicCollapsiblePanel​(String text)
        Constructor for a label/button controlled collapsible panel. Displays a clickable title that resembles a native titled border except for an arrow on the right side indicating an expandable panel. The actual border only appears when the panel is expanded.
        Parameters:
        text - Title of the collapsible panel in string format, used to create a button with text and an arrow icon

    • Method Detail

      • setTitleComponentText

        public void setTitleComponentText​(String text)
        Sets the title of of the border title component.
        Parameters:
        text - The string title.

      • getContentPane

        public JPanel getContentPane()
        This class requires that all content be placed within a designated panel, this method returns that panel.
        Returns:
        panel The content panel.

      • add

        public Component add​(Component comp)
        Overridden to add any new components to the content panel, as might be expected.
        Overrides:
        add in class Container
        Parameters:
        comp - The component to add.

      • add

        public Component add​(Component comp,
                     int index)
        Overridden to add any new components to the content panel, as might be expected.
        Overrides:
        add in class Container
        Parameters:
        comp - The component to add.
        index - The index at which to add the component.

      • add

        public void add​(Component comp,
                Object constraints)
        Overridden to add any new components to the content panel, as might be expected.
        Overrides:
        add in class Container
        Parameters:
        comp - The component to add.
        constraints - The constraints to adding.

      • add

        public void add​(Component comp,
                Object constraints,
                int index)
        Overridden to add any new components to the content panel, as might be expected.
        Overrides:
        add in class Container
        Parameters:
        comp - The component to add.
        constraints - The constraints to adding.
        index - The index at which to add the component.

      • add

        public Component add​(String name,
                     Component comp)
        Overridden to add any new components to the content panel, as might be expected.
        Overrides:
        add in class Container
        Parameters:
        name - The name of the component to add.
        comp - The component to add.

      • setCollapsed

        public void setCollapsed​(boolean collapse)
        Collapses or expands the panel. This is done by adding or removing the content pane, alternating between a frame and empty border, and changing the title arrow. Also, the current state is stored in the collapsed boolean.
        Parameters:
        collapse - When set to true, the panel is collapsed, else it is expanded

      • isCollapsed

        public boolean isCollapsed()
        Returns the current state of the panel, collapsed (true) or expanded (false).
        Returns:
        collapsed Returns true if the panel is collapsed and false if it is expanded

      • setToolTipText

        public void setToolTipText​(String text)
        Sets the tooltip text of this BasicCollapsiblePanel.
        Overrides:
        setToolTipText in class JComponent
        Parameters:
        text - The string to set as the tooltip.