Package com.jidesoft.swing

Class SidePaneItem

  • public class SidePaneItem
extends java.lang.Object
    SidePaneItem is a data structure used by SidePane. It has a title, an icon, a component and a mouse listener.
    See Also:
    SidePane

    • Constructor Summary

      Constructors 
      Constructor Description
      SidePaneItem​(java.lang.String title)
      Constructs a SidePaneItem with title.
      SidePaneItem​(java.lang.String title, javax.swing.Icon icon)
      Constructs a SidePaneItem with title and icon.
      SidePaneItem​(java.lang.String title, javax.swing.Icon icon, java.awt.Component component)
      Constructs a SidePaneItem with title, icon and component.
      SidePaneItem​(java.lang.String title, javax.swing.Icon icon, java.awt.Component component, javax.swing.event.MouseInputListener listener)
      Constructs a SidePaneItem with title, icon and component.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.awt.Color getBackground()
      Gets the background.
      java.awt.Component getComponent()
      Gets the component.
      java.awt.Font getFont()
      Gets the font.
      java.awt.Color getForeground()
      Gets the foreground.
      javax.swing.Icon getIcon()
      Gets the icon.
      javax.swing.event.MouseInputListener getMouseListener()
      Gets the mouse listener.
      java.lang.String getTitle()
      Gets the title.
      boolean isSelected()
      True if the item is selected.
      void setBackground​(java.awt.Color background)
      Sets the background.
      void setComponent​(java.awt.Component component)
      Sets the component.
      void setFont​(java.awt.Font font)
      Sets the font.
      void setForeground​(java.awt.Color foreground)
      Sets the foreground.
      void setIcon​(javax.swing.Icon icon)
      Sets the icon.
      void setMouseInputListener​(javax.swing.event.MouseInputListener mouseListener)
      Sets the mouse listener.
      void setSelected​(boolean selected)
      Selects the item.
      void setTitle​(java.lang.String title)
      Sets the title.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • SidePaneItem

        public SidePaneItem​(java.lang.String title)
        Constructs a SidePaneItem with title.
        Parameters:
        title - title of SidePaneItem

      • SidePaneItem

        public SidePaneItem​(java.lang.String title,
                    javax.swing.Icon icon)
        Constructs a SidePaneItem with title and icon.
        Parameters:
        title - title of SidePaneItem
        icon - icon of SidePaneItem

      • SidePaneItem

        public SidePaneItem​(java.lang.String title,
                    javax.swing.Icon icon,
                    java.awt.Component component)
        Constructs a SidePaneItem with title, icon and component.
        Parameters:
        title - title of SidePaneItem
        icon - icon of SidePaneItem
        component - component in SidePaneItem

      • SidePaneItem

        public SidePaneItem​(java.lang.String title,
                    javax.swing.Icon icon,
                    java.awt.Component component,
                    javax.swing.event.MouseInputListener listener)
        Constructs a SidePaneItem with title, icon and component.
        Parameters:
        title - title of SidePaneItem
        icon - icon of SidePaneItem
        component - component in SidePaneItem
        listener - mouse listener when user hover or click on SidePane

    • Method Detail

      • getIcon

        public javax.swing.Icon getIcon()
        Gets the icon.
        Returns:
        the icon

      • setIcon

        public void setIcon​(javax.swing.Icon icon)
        Sets the icon.
        Parameters:
        icon - the new icon

      • getTitle

        public java.lang.String getTitle()
        Gets the title.
        Returns:
        the title

      • setTitle

        public void setTitle​(java.lang.String title)
        Sets the title.
        Parameters:
        title - the new title

      • getComponent

        public java.awt.Component getComponent()
        Gets the component.
        Returns:
        the component

      • setComponent

        public void setComponent​(java.awt.Component component)
        Sets the component.
        Parameters:
        component - the new component

      • getMouseListener

        public javax.swing.event.MouseInputListener getMouseListener()
        Gets the mouse listener.
        Returns:
        the mouse listener

      • setMouseInputListener

        public void setMouseInputListener​(javax.swing.event.MouseInputListener mouseListener)
        Sets the mouse listener.
        Parameters:
        mouseListener - the new mouse listener

      • isSelected

        public boolean isSelected()
        True if the item is selected.
        Returns:
        true if the item is selected.

      • setSelected

        public void setSelected​(boolean selected)
        Selects the item.
        Parameters:
        selected - the flag

      • setForeground

        public void setForeground​(java.awt.Color foreground)
        Sets the foreground.
        Parameters:
        foreground - the foreground color

      • setBackground

        public void setBackground​(java.awt.Color background)
        Sets the background.
        Parameters:
        background - the background color

      • getFont

        public java.awt.Font getFont()
        Gets the font.
        Returns:
        the font. null means that default font will be used.

      • setFont

        public void setFont​(java.awt.Font font)
        Sets the font.
        Parameters:
        font - the font