Package com.nomagic.magicdraw.ui.zoom

Class ZoomHelper

  • @OpenApi
public class ZoomHelper
extends java.lang.Object
    Helper functions to display zoomed GUI components

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static int getOriginalSize​(int scaledSize, float zoomFactor)
      Opposite method to getScaledSize(int, float).
      static java.awt.Font getScaledFont​(java.awt.Font font, float zoomFactor)
      Takes the provided font and scales it's size by the given zoomFactor.
      static javax.swing.Icon getScaledIcon​(javax.swing.Icon icon, float zoomFactor)
      Takes the provided icon and scales it's size by the given zoomFactor.
      static int getScaledSize​(int size, float zoomFactor)
      Takes the provided integer and scales (multiplies) it by the given zoomFactor.
      static boolean zoomComponent​(java.awt.Component component, float zoomFactor)
      If component implements Zoomable interface, zooms the component by the given factor.
      static boolean zoomComponents​(java.awt.Container container, float zoomFactor)
      Iterates through inner components recursively and zooms all components that implement Zoomable interface.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • getScaledSize

        @OpenApi
public static int getScaledSize​(int size,
                                float zoomFactor)
        Takes the provided integer and scales (multiplies) it by the given zoomFactor. Trims the floating part of the result down.
        Returns:
        scaled size

      • getOriginalSize

        @OpenApi
public static int getOriginalSize​(int scaledSize,
                                  float zoomFactor)
        Opposite method to getScaledSize(int, float). Takes the provided scaledSize, which is already scaled by the given zoomFactor and returns the original not scaled size, by dividing the scaledSize from zoomFactor.
        Returns:
        not scaled size

      • getScaledFont

        @OpenApi
@CheckForNull
public static java.awt.Font getScaledFont​(@CheckForNull
                                          java.awt.Font font,
                                          float zoomFactor)
        Takes the provided font and scales it's size by the given zoomFactor.
        Returns:
        scaled font

      • getScaledIcon

        @OpenApi
@CheckForNull
public static javax.swing.Icon getScaledIcon​(@CheckForNull
                                             javax.swing.Icon icon,
                                             float zoomFactor)
        Takes the provided icon and scales it's size by the given zoomFactor. Icon caching is used to prevent repeated scaling of the same icon and zoomFactor.
        Returns:
        scaled icon

      • zoomComponent

        @OpenApi
public static boolean zoomComponent​(java.awt.Component component,
                                    float zoomFactor)
        If component implements Zoomable interface, zooms the component by the given factor. If component does not implement Zoomable, but it is a Container, then looks for Zoomable inner components recursively and zooms each of them.
        Returns:
        true if component or at least one of it's sub components was zoomed
        See Also:
        zoomComponents(java.awt.Container, float)

      • zoomComponents

        @OpenApi
public static boolean zoomComponents​(java.awt.Container container,
                                     float zoomFactor)
        Iterates through inner components recursively and zooms all components that implement Zoomable interface.
        Returns:
        true if at least one of Container's inner components is Zoomable