Package com.jidesoft.swing

Class Resizable

java.lang.Object
com.jidesoft.swing.Resizable
public class Resizable extends Object
Resizable is a class that supports the resizable feature.

To use it and make a component resizable, you just need to create new Resizable(component) and pass in that component to the constructor. Resizable uses beginResizing(int), resizing(int, int, int, int, int) and endResizing(int) to archive the resizing effect. It should work for most cases. However if it doesn't work as expected for some layouts, you can override one of all of the three methods to make it working.

  • Field Details

  • Constructor Details

    • Resizable

      public Resizable(JComponent component)
      Creates a new Resizable. This call will make the component to be resizable.
      Parameters:
      component - the component that should be resizable.

  • Method Details

    • getResizableCorners

      public int getResizableCorners()
      Gets the resizable corners. The value is a bitwise OR of eight constants defined in Resizable.
      Returns:
      resizable corners.

    • setResizableCorners

      public void setResizableCorners(int resizableCorners)
      Sets resizable corners.
      Parameters:
      resizableCorners - new resizable corners. The value is a bitwise OR of eight constants defined in Resizable.

    • getResizeCornerSize

      public int getResizeCornerSize()
      Gets resize corner size. This size is the corner's sensitive area which will trigger the resizing from both sides.
      Returns:
      the resize corner size.

    • setResizeCornerSize

      public void setResizeCornerSize(int resizeCornerSize)
      Sets the resize corner size.
      Parameters:
      resizeCornerSize - the resize corner size.

    • installListeners

      protected void installListeners()
      Installs the listeners needed to perform resizing operations. You do not need to call this method directly. Constructor will call this method automatically.

    • uninstallListeners

      public void uninstallListeners()
      Uninstalls the listeners that created to perform resizing operations. After the uninstallation, the component will not be resizable anymore.

    • createMouseInputListener

      protected MouseInputListener createMouseInputListener()
      Creates the MouseInputListener for resizing. Subclass can override this method to provide its own MouseInputListener to customize existing one.
      Returns:
      the MouseInputListener for resizing.

    • getMouseInputAdapter

      public MouseInputListener getMouseInputAdapter()
      Gets the mouse adapter for resizing.
      Returns:
      the mouse adapter for resizing.

    • beginResizing

      public void beginResizing(int resizeCorner)
      This method is called when resizing operation started.
      Parameters:
      resizeCorner - the resize corner.

    • resizing

      public void resizing(int resizeCorner, int newX, int newY, int newW, int newH)
      This method is called during the resizing of ResizablePanel. In default implementation, it call 
       setPreferredSize(new Dimension(newW, newH));
 getParent().doLayout();
      in fact, depending on where you added this ResizablePanel, you may need to override this method to do something else. For example, ResizableWindow uses ResizablePanel to implement resizable feature in JWindow. It overrides this method to call setBounds on JWindow itself.
      Parameters:
      resizeCorner - the resize corner.
      newX - the new x position.
      newY - the new y position.
      newW - the new width.
      newH - the new height.

    • endResizing

      public void endResizing(int resizeCorner)
      The method is called when resizing ends.
      Parameters:
      resizeCorner - the resize corner.

    • isTopLevel

      public boolean isTopLevel()
      Checks if the Resizable is added to a top level component.

      If it's top level component, it will use screen coordinates to do all calculations during resizing. If resizing the resizable panel won't affect any top level container's position, you can return false here. Otherwise, return true. The default implementation always return false. Subclasses can override to return different value. In the case of ResizableWindow or ResizableDialog, this method is overridden and returns true.

      Returns:
      false.

    • setTopLevel

      public void setTopLevel(boolean topLevel)
      To indicates this Resizable is installed on a top level component such as JWindow, JDialog and JFrame v.s. a JPanel which is not a top level component because a JPanel must be added to another top level component in order to be displayed.
      Parameters:
      topLevel - true or false.

    • getComponent

      public JComponent getComponent()
      Gets the component which has this Resizable object.
      Returns:
      the component which has this Resizable object.

    • getResizeInsets

      public Insets getResizeInsets()
      Returns the insets that should be used to calculate the resize area. Unless you have used setResizeInsets or overridden this method, it'll return the insets of the component.
      Returns:
      the insets that should be used to calculate the resize area.

    • setResizeInsets

      public void setResizeInsets(Insets resizeInsets)
      Sets the insets the be used to calculate the resize area.
      Parameters:
      resizeInsets -

    • getSnapGridSize

      public int getSnapGridSize()
      Gets the snap grid size.
      Returns:
      the snap grid size.
      See Also:

    • setSnapGridSize

      public void setSnapGridSize(int snapGridSize)
      Sets the snap grid size.

      Snap grid size is used to make resizing easier.

      By default, the size is 1 pixel.

      Parameters:
      snapGridSize - the grid size