com.helger.commons.gfx

Class ScalableSize

java.lang.Object

com.helger.commons.gfx.ScalableSize

All Implemented Interfaces:

IHasHeight, IHasWidth, IHasWidthAndHeight, Serializable

@Immutable
public final class ScalableSize
extends Object
implements IHasWidthAndHeight, Serializable

This class represents an object having width and height.

Author:

Philip Helger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ScalableSize(IHasWidthAndHeight aObj)
ScalableSize(int nWidth, int nHeight)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
ScalableSize	getAdded(IHasWidthAndHeight aToAdd)
ScalableSize	getBestMatchingSize(int nMaxWidth, int nMaxHeight) Return the scaled width and height relative to a maximum size.
int	getHeight()
ScalableSize	getScaledToHeight(int nNewHeight)
ScalableSize	getScaledToWidth(int nNewWidth)
ScalableSize	getSubtracted(IHasWidthAndHeight aToSubtract)
int	getWidth()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ScalableSize

public ScalableSize(@Nonnull
            IHasWidthAndHeight aObj)

ScalableSize

public ScalableSize(@Nonnegative
            int nWidth,
            @Nonnegative
            int nHeight)

Method Detail

getWidth

@Nonnegative
public int getWidth()

Specified by:

getWidth in interface IHasWidth

Returns:

The width of an object

getHeight

@Nonnegative
public int getHeight()

Specified by:

getHeight in interface IHasHeight

Returns:

The height of an object

getBestMatchingSize

@Nonnull
@CheckReturnValue
public ScalableSize getBestMatchingSize(@Nonnegative
                                                        int nMaxWidth,
                                                        @Nonnegative
                                                        int nMaxHeight)

Return the scaled width and height relative to a maximum size.

Parameters:

nMaxWidth - Maximum width. Must be > 0.

nMaxHeight - Maximum height. Must be > 0.

Returns:

An array with 2 elements, where the first element is the width, and the second is the height.

getScaledToWidth

@Nonnull
@CheckReturnValue
public ScalableSize getScaledToWidth(@Nonnegative
                                                     int nNewWidth)

getScaledToHeight

@Nonnull
@CheckReturnValue
public ScalableSize getScaledToHeight(@Nonnegative
                                                      int nNewHeight)

getAdded

@Nonnull
@CheckReturnValue
public ScalableSize getAdded(@Nonnull
                                             IHasWidthAndHeight aToAdd)

getSubtracted

@Nonnull
@CheckReturnValue
public ScalableSize getSubtracted(@Nonnull
                                                  IHasWidthAndHeight aToSubtract)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object