Package com.jidesoft.swing

Class Gripper

  • All Implemented Interfaces:
    Alignable, DraggableHandle, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.swing.plaf.UIResource, javax.swing.SwingConstants
    public class Gripper
extends javax.swing.JComponent
implements javax.swing.SwingConstants, Alignable, DraggableHandle, javax.swing.plaf.UIResource
    Gripper is a component that you can drag. Actually the component itself doesn't allow you to drag, it is up to the component who uses this Gripper to add mouse motion listener and do the dragging. The Gripper will paint itself so that user can tell immediately that it is something draggable.
    See Also:
    Serialized Form

    • Nested Class Summary

      • Nested classes/interfaces inherited from class javax.swing.JComponent

        javax.swing.JComponent.AccessibleJComponent

      • Nested classes/interfaces inherited from class java.awt.Container

        java.awt.Container.AccessibleAWTContainer

      • Nested classes/interfaces inherited from class java.awt.Component

        java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ROLLOVER_ENABLED_CHANGED_PROPERTY
      Identifies a change from rollover enabled to disabled or back to enabled.
      static java.lang.String ROLLOVER_PROPERTY  
      static java.lang.String SELECTED_PROPERTY  

      • Fields inherited from class javax.swing.JComponent

        listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

      • Fields inherited from class java.awt.Component

        accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

      • Fields inherited from interface java.awt.image.ImageObserver

        ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

      • Fields inherited from interface javax.swing.SwingConstants

        BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST

    • Constructor Summary

      Constructors 
      Constructor Description
      Gripper()
      Creates a new horizontal separator.
      Gripper​(int orientation)
      Creates a new separator with the specified horizontal or vertical orientation.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.awt.Cursor getCursor()
      Gets the cursor set in the component.
      int getOrientation()
      Gets the orientation.
      GripperUI getUI()
      Returns the L&F object that renders this component.
      java.lang.String getUIClassID()
      Returns the name of the L&F class that renders this component.
      boolean isRollover()  
      boolean isRolloverEnabled()
      Gets the rolloverEnabled property.
      boolean isSelected()  
      void setOrientation​(int orientation)
      Changes the orientation.
      void setRollover​(boolean rollover)  
      void setRolloverEnabled​(boolean b)
      Sets the rolloverEnabled property, which must be true for rollover effects to occur.
      void setSelected​(boolean selected)  
      boolean supportHorizontalOrientation()
      return true if it supports horizontal orientation.
      boolean supportVerticalOrientation()
      return true if it supports vertical orientation.
      void updateUI()
      Resets the UI property to a value from the current look and feel.

      • Methods inherited from class javax.swing.JComponent

        addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

      • Methods inherited from class java.awt.Container

        add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

      • Methods inherited from class java.awt.Component

        action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • ROLLOVER_ENABLED_CHANGED_PROPERTY

        public static final java.lang.String ROLLOVER_ENABLED_CHANGED_PROPERTY
        Identifies a change from rollover enabled to disabled or back to enabled.
        See Also:
        Constant Field Values

      • ROLLOVER_PROPERTY

        public static final java.lang.String ROLLOVER_PROPERTY
        See Also:
        Constant Field Values

      • SELECTED_PROPERTY

        public static final java.lang.String SELECTED_PROPERTY
        See Also:
        Constant Field Values

    • Constructor Detail

      • Gripper

        public Gripper()
        Creates a new horizontal separator.

      • Gripper

        public Gripper​(int orientation)
        Creates a new separator with the specified horizontal or vertical orientation.
        Parameters:
        orientation - an integer specifying SwingConstants.HORIZONTAL or SwingConstants.VERTICAL
        Throws:
        java.lang.IllegalArgumentException - if orientation is neither SwingConstants.HORIZONTAL nor SwingConstants.VERTICAL

    • Method Detail

      • getUI

        public GripperUI getUI()
        Returns the L&F object that renders this component.
        Overrides:
        getUI in class javax.swing.JComponent
        Returns:
        the SeparatorUI object that renders this component

      • updateUI

        public void updateUI()
        Resets the UI property to a value from the current look and feel.
        Overrides:
        updateUI in class javax.swing.JComponent
        See Also:
        JComponent.updateUI()

      • getUIClassID

        public java.lang.String getUIClassID()
        Returns the name of the L&F class that renders this component.
        Overrides:
        getUIClassID in class javax.swing.JComponent
        Returns:
        the string "GripperUI"
        See Also:
        JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

      • supportVerticalOrientation

        public boolean supportVerticalOrientation()
        return true if it supports vertical orientation.
        Specified by:
        supportVerticalOrientation in interface Alignable
        Returns:
        true if it supports vertical orientation

      • supportHorizontalOrientation

        public boolean supportHorizontalOrientation()
        return true if it supports horizontal orientation.
        Specified by:
        supportHorizontalOrientation in interface Alignable
        Returns:
        true if it supports horizontal orientation

      • setOrientation

        public void setOrientation​(int orientation)
        Changes the orientation.
        Specified by:
        setOrientation in interface Alignable
        Parameters:
        orientation - the new orientation.

      • getOrientation

        public int getOrientation()
        Gets the orientation.
        Specified by:
        getOrientation in interface Alignable
        Returns:
        orientation

      • getCursor

        public java.awt.Cursor getCursor()
        Gets the cursor set in the component. If the component does not have a cursor set, the cursor of its parent is returned. If no cursor is set in the entire hierarchy, Cursor.DEFAULT_CURSOR is returned.
        Overrides:
        getCursor in class java.awt.Component
        Since:
        JDK1.1
        See Also:
        Component.setCursor(java.awt.Cursor)

      • isRolloverEnabled

        public boolean isRolloverEnabled()
        Gets the rolloverEnabled property.
        Returns:
        the value of the rolloverEnabled property
        See Also:
        setRolloverEnabled(boolean)

      • setRolloverEnabled

        public void setRolloverEnabled​(boolean b)
        Sets the rolloverEnabled property, which must be true for rollover effects to occur. The default value for the rolloverEnabled property is false. Some look and feels might not implement rollover effects; they will ignore this property.
        Parameters:
        b - if true, rollover effects should be painted
        See Also:
        isRolloverEnabled()

      • isRollover

        public boolean isRollover()

      • setRollover

        public void setRollover​(boolean rollover)

      • isSelected

        public boolean isSelected()

      • setSelected

        public void setSelected​(boolean selected)