com.groupdocs.editor.htmlcss.css.datatypes

Class Ratio

  • java.lang.Object
    • com.aspose.ms.System.ValueType<T>
      • com.aspose.ms.lang.Struct<Ratio>
        • com.groupdocs.editor.htmlcss.css.datatypes.Ratio
  • All Implemented Interfaces:
    com.aspose.ms.System.ICloneable, com.aspose.ms.System.IEquatable<com.groupdocs.editor.htmlcss.css.datatypes.ICssDataType>, com.groupdocs.editor.htmlcss.css.datatypes.ICssDataType

    public class Ratio
extends com.aspose.ms.lang.Struct<Ratio>
implements com.groupdocs.editor.htmlcss.css.datatypes.ICssDataType, com.aspose.ms.System.ICloneable

    Represents a "ratio" CSS data type, which is used for describing aspect ratios in media queries and for raster images by denoting the proportion between two unitless values called "numerator" and "denominator". Immutable struct.

    https://developer.mozilla.org/en-US/docs/Web/CSS/ratio

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static Ratio Single
      Single default ratio 1/1

    • Constructor Summary

      Constructors 
      Constructor and Description
      Ratio() 

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      double calculate()
      Calculates and returns this ratio as a single floating point number
      Object clone() 
      Ratio Clone() 
      void CloneTo(Ratio that) 
      static Ratio create(int numerator, int denominator)
      Creates and returns one Ratio instance from specified numerator and denominator
      Ratio deepClone()
      Returns a full copy of this ratio
      boolean equals(com.groupdocs.editor.htmlcss.css.datatypes.ICssDataType other)
      Determines whether this instance is equal with specified ICssDataType inheritor, which presumably is another "Ratio" instance
      boolean equals(Object other)
      Determines whether this instance is equal with specified uncasted object, which presumably is another "Ratio" instance
      boolean equals(Ratio other)
      Determines whether this instance is equal with specified "Ratio" instance
      static boolean equals(Ratio obj1, Ratio obj2) 
      int getDenominator()
      Returns a denominator of this ratio
      Ratio getInverseRatio()
      Generates and returns an inverse (reciprocal) ratio for this ratio
      int getNumerator()
      Returns a numerator of this ratio
      int hashCode()
      Returns a hashcode for this instance, which cannot be changed during its lifetime
      boolean isDefault()
      Determines whether this ratio has default value or is a "1/1" (Single)
      static boolean op_Equality(Ratio left, Ratio right)
      Compares two ratios and returns a boolean indicating if the two do match.
      static boolean op_Inequality(Ratio left, Ratio right)
      Compares two ratios and returns a boolean indicating if the two do not match.
      String serializeDefault()
      Serializes this ratio to the string and returns it
      String toString()
      Returns a string representation of this ratio; same as "SerializeDefault()"

    • Field Detail

      • Single

        public static final Ratio Single

        Single default ratio 1/1

    • Constructor Detail

      • Ratio

        public Ratio()

    • Method Detail

      • calculate

        public final double calculate()

        Calculates and returns this ratio as a single floating point number

        Returns:
        Floating-point number with double precision

      • Clone

        public Ratio Clone()
        Specified by:
        Clone in class com.aspose.ms.System.ValueType<Ratio>

      • CloneTo

        public void CloneTo(Ratio that)
        Specified by:
        CloneTo in class com.aspose.ms.System.ValueType<Ratio>

      • create

        public static Ratio create(int numerator,
           int denominator)

        Creates and returns one Ratio instance from specified numerator and denominator

        Parameters:
        numerator - Numerator for the ratio. Should be a strictly positive integer number.
        denominator - Denominator for the ratio. Should be a strictly positive integer number.
        Returns:
        New Ratio instance

      • deepClone

        public final Ratio deepClone()

        Returns a full copy of this ratio

        Specified by:
        deepClone in interface com.aspose.ms.System.ICloneable
        Returns:
        New Ratio instance, that is a full and deep copy of this one

      • equals

        public final boolean equals(com.groupdocs.editor.htmlcss.css.datatypes.ICssDataType other)

        Determines whether this instance is equal with specified ICssDataType inheritor, which presumably is another "Ratio" instance

        Parameters:
        other - Other ICssDataType instance, that is presumably of Ratio type, to check on equality with this
        Returns:
        True if are equal, false if are unequal

      • equals

        public boolean equals(Object other)

        Determines whether this instance is equal with specified uncasted object, which presumably is another "Ratio" instance

        Specified by:
        equals in interface com.aspose.ms.System.IEquatable<com.groupdocs.editor.htmlcss.css.datatypes.ICssDataType>
        Overrides:
        equals in class Object
        Parameters:
        other - Other System.Object instance, that is presumably of Ratio type, to check on equality with this
        Returns:
        True if are equal, false if are unequal

      • equals

        public final boolean equals(Ratio other)

        Determines whether this instance is equal with specified "Ratio" instance

        Parameters:
        other - Other Ratio instance to check on equality with this
        Returns:
        True if are equal, false if are unequal

      • equals

        public static boolean equals(Ratio obj1,
             Ratio obj2)

      • getDenominator

        public final int getDenominator()

        Returns a denominator of this ratio

      • getInverseRatio

        public final Ratio getInverseRatio()

        Generates and returns an inverse (reciprocal) ratio for this ratio

        Returns:
        New Ratio instance, that is an inverse ratio for this one

      • getNumerator

        public final int getNumerator()

        Returns a numerator of this ratio

      • hashCode

        public int hashCode()

        Returns a hashcode for this instance, which cannot be changed during its lifetime

        Overrides:
        hashCode in class Object
        Returns:
        Signed 4-byte integer, that is immutable for this instance

      • isDefault

        public final boolean isDefault()

        Determines whether this ratio has default value or is a "1/1" (Single)

        Specified by:
        isDefault in interface com.groupdocs.editor.htmlcss.css.datatypes.ICssDataType
        Returns:

      • op_Equality

        public static boolean op_Equality(Ratio left,
                  Ratio right)

        Compares two ratios and returns a boolean indicating if the two do match.

        Parameters:
        left - The first ratio to use.
        right - The second ratio to use.
        Returns:
        True if both ratios are equal, otherwise false.

      • op_Inequality

        public static boolean op_Inequality(Ratio left,
                    Ratio right)

        Compares two ratios and returns a boolean indicating if the two do not match.

        Parameters:
        left - The first ratio to use.
        right - The second ratio to use.
        Returns:
        True if both ratios are not equal, otherwise false.

      • serializeDefault

        public final String serializeDefault()

        Serializes this ratio to the string and returns it

        Specified by:
        serializeDefault in interface com.groupdocs.editor.htmlcss.css.datatypes.ICssDataType
        Returns:
        String in "numerator/denominator" format

      • toString

        public String toString()

        Returns a string representation of this ratio; same as "SerializeDefault()"

        Overrides:
        toString in class Object
        Returns:
        String in "numerator/denominator" format