Class GUnit

Method Details

• getScriptEngine

  public static ScriptEngine getScriptEngine() throws GUnitException

  Returns the script engine manager.

  Throws:

  GUnitException - If engine cannot be instantiated.

• createGUnit

  public static GUnit createGUnit(String expr0, String... specialValues) throws GUnitException

  Creates a GUnit object from a String. The String must be in the formats:

    - [+|-] nnn [unit]
    - [+|-] nnn[.ddd] [unit]
    - formula consisting of characters "()+-/* 0123456789." and the unit characters
   

  Parameters:

  expr0 - The expression string.

  specialValues - Accepted special values.

  Returns:

  GUnit the created unit.

  Throws:

  GUnitException - The error message.

• createCSSGUnit

  public static GUnit createCSSGUnit(String value, String... specialValues) throws GUnitException

  Creates a GUnit object from a String. The String must be in the formats:

    - [+|-] nnn [unit]
    - [+|-] nnn[.ddd] [unit]
   

  All formats except "pixel" supports decimals ([.ddd] above).

  Formulas are not supported. The following units are supported:

  • px: pixel,
  • pt: point,
  • em: width of "M",
  • ex: width of "x",
  • %: percentage width of parent,
  • vw: viewport width,
  • vh: viewport height.

  Parameters:

  value - The value string.

  specialValues - Accepted special values.

  Returns:

  GUnit the created unit.

  Throws:

  GUnitException - The error message.

• validateCSSGUnit

  public static void validateCSSGUnit(GUnit unit, String... specialValues) throws GUnitException

  Validates a GUnit object.

  Formulas are not supported. The following units are supported:

  • px: pixel,
  • pt: point,
  • em: width of "M",
  • ex: width of "x",
  • %: percentage width of parent,
  • vw: viewport width,
  • vh: viewport height.

  Parameters:

  unit - The unit as CSS value.

  specialValues - Accepted special values.

  Throws:

  GUnitException - The error message.

• getType

  public int getType()

  Gets the type of the unit (0-19), one of the values:

  • UT_PX (pixel),
  • UT_DLG (dialog),
  • UT_EM ("em"),
  • UT_EX ("ex"),
  • UT_PT (point),
  • UT_PC (percent),
  • UT_PCW (percentage of parent width),
  • UT_PCH (percentage of parent height),
  • UT_PCMIN (minimum size of percentage of parent width and height),
  • UT_PCMAX (maximum size of percentage of parent width and height),
  • UT_VW (percentage of viewport width),
  • UT_VH (percentage of viewport height),
  • UT_VMIN (size for minimum size of percentage of viewport width and height),
  • UT_VMAX (size for maximum size of percentage of viewport width and height),
  • UT_NL (size of the notch LEFT side safe size in pixels),
  • UT_NR (size of the notch RIGHT side safe size in pixels),
  • UT_NW (size of the maximum notch LEFT/RIGHT side or WIDTH safe size in pixels),
  • UT_NT (size of the notch TOP side safe size in pixels),
  • UT_NB (size of the notch BOTTOM side safe size in pixels),
  • UT_FORMULA (formula) or
  • UT_VALUE (special value).

• isLocked

  public boolean isLocked()

  Checks if the unit is "locked" from user change in the GUI design editor.

  Returns:

  The lock flag.

• setLocked

  public void setLocked(boolean on)

  Sets the lock state of the unit.

  Parameters:

  on - The lock flag.

• getString

  public String getString()

  Gets the String representation of the bounds as "value type".

  Returns:

  A string in the form of value type.

• isZero

  public boolean isZero()

  Checks if the unit is zero.

  Returns:

  true if the value is zero when not a UT_FORMULA or UT_VALUE string such as "fixed", false otherwise.

• equals

  public boolean equals(Object o)

  Checks if two unit objects are equal.

  Overrides:

  equals in class Object

  Parameters:

  o - another unit object. If null, the units are not equal.

  Returns:

  true if the object has the same type and value.

• equals

  public boolean equals(GUnit unit)

  Checks if two unit objects are equal.

  Parameters:

  unit - another size object. If null, the sizes are not equal.

  Returns:

  true if the object has the same type and value.

• clone

  public GUnit clone()

  Clones this instance.

  Overrides:

  clone in class Object

  Returns:

  As cloned instance of GUnit.

• paramString

  protected String paramString()

  Returns the parameter string representing the state of this event. This string is useful for debugging. Super-classes adds extra information to the string by preceding it with a comma followed by the extra information.

  Returns:

  the parameter string of this unit object.

• getValue

  public double getValue()

  Returns the double value for the unit.

  Returns:

  The value for PT, PX, %, DLG, EX and EM, or Double.NaN otherwise.

• toString

  public String toString()

  Returns a string representation of this class instance.

  Overrides:

  toString in class Object

  Returns:

  A string representation of this class instance.

• getCSSValue

  public String getCSSValue()

  Gets the unit as a CSS value. Formula and percent is NOT accepted and returns null along with a warning logging.

  Returns:

  The CSS value, or null if it's a UT_FORMULA.

• append

  public void append(SendTransaction trans)

  Appends the unit object to a transaction.

  Parameters:

  trans - The transaction.

• validate

  public String validate() throws GUnitException

  Validates an expression formula.

  Throws:

  GUnitException - For validation errors.

• getPixelValue

  public double getPixelValue(UIComp comp, boolean isHorz)

  Calculates the unit into a pixel value using the font information.

  Parameters:

  comp - The component.

  isHorz - Flag indicating this is a horizontal value (significant only for % or DLG).

  Returns:

  The pixel value, or Double.NaN if the expression is invalid. Note: the Notch values always returns zero.

  Throws:

  IllegalStateException - If this is called outside of the Designer.

• isPureCSS

  public boolean isPureCSS()

  Checks if this is a valid CSS pure unit, e.g. not DLG, Formula.

  Returns:

  true if it's a pure CSS unit, false if it is a calculated value and cannot be used in CSS declarations.

• isContainerDependent

  public boolean isContainerDependent()

  Returns if this value is dependent on the container size, i.e. value is a percent value or a formula containing percent.

  Returns:

  true if the value is container dependent, i.e. a Percent value, or if it is a formula contains a percent value. false is returned if the value is not dependent of the container.