Dimension

class Dimension

Class representing a length measurement in CSS.

Constructors

Dimension.cm()

Dimension.cm(num _value)

Set this CSS Dimension to a centimeter value.

Implementation

Dimension.cm(this._value) : _unit = 'cm';

Dimension.css()

Dimension.css(String cssValue)

Construct a Dimension object from the valid, simple CSS string cssValue that represents a distance measurement.

This constructor is intended as a convenience method for working with simplistic CSS length measurements. Non-numeric values such as auto or inherit or invalid CSS will cause this constructor to throw a FormatError.

Implementation

Dimension.css(String cssValue) : _unit = '', _value = 0 {
  if (cssValue == '') cssValue = '0px';
  if (cssValue.endsWith('%')) {
    _unit = '%';
  } else {
    _unit = cssValue.substring(cssValue.length - 2);
  }
  if (cssValue.contains('.')) {
    _value = double.parse(
      cssValue.substring(0, cssValue.length - _unit.length),
    );
  } else {
    _value = int.parse(cssValue.substring(0, cssValue.length - _unit.length));
  }
}

Dimension.em()

Dimension.em(num _value)

Set this CSS Dimension to the specified number of ems.

1em is equal to the current font size. (So 2ems is equal to double the font size). This is useful for producing website layouts that scale nicely with the user's desired font size.

Implementation

Dimension.em(this._value) : _unit = 'em';

Dimension.ex()

Dimension.ex(num _value)

Set this CSS Dimension to the specified number of x-heights.

One ex is equal to the x-height of a font's baseline to its mean line, generally the height of the letter "x" in the font, which is usually about half the font-size.

Implementation

Dimension.ex(this._value) : _unit = 'ex';

Dimension.inch()

Dimension.inch(num _value)

Set this CSS Dimension to an inch value.

Implementation

Dimension.inch(this._value) : _unit = 'in';

Dimension.mm()

Dimension.mm(num _value)

Set this CSS Dimension to a millimeter value.

Implementation

Dimension.mm(this._value) : _unit = 'mm';

Dimension.pc()

Dimension.pc(num _value)

Set this CSS Dimension to a pica value.

Implementation

Dimension.pc(this._value) : _unit = 'pc';

Dimension.percent()

Dimension.percent(num _value)

Set this CSS Dimension to a percentage value.

Implementation

Dimension.percent(this._value) : _unit = '%';

Dimension.pt()

Dimension.pt(num _value)

Set this CSS Dimension to a point value.

Implementation

Dimension.pt(this._value) : _unit = 'pt';

Dimension.px()

Dimension.px(num _value)

Set this CSS Dimension to a pixel value.

Implementation

Dimension.px(this._value) : _unit = 'px';

Properties

hashCode no setter inherited

int get hashCode

The hash code for this object.

A hash code is a single integer which represents the state of the object that affects operator == comparisons.

All objects have hash codes. The default hash code implemented by Object represents only the identity of the object, the same way as the default operator == implementation only considers objects equal if they are identical (see identityHashCode).

If operator == is overridden to use the object state instead, the hash code must also be changed to represent that state, otherwise the object cannot be used in hash based data structures like the default Set and Map implementations.

Hash codes must be the same for objects that are equal to each other according to operator ==. The hash code of an object should only change if the object changes in a way that affects equality. There are no further requirements for the hash codes. They need not be consistent between executions of the same program and there are no distribution guarantees.

Objects that are not equal are allowed to have the same hash code. It is even technically allowed that all instances have the same hash code, but if clashes happen too often, it may reduce the efficiency of hash-based data structures like HashSet or HashMap.

If a subclass overrides hashCode, it should override the operator == operator as well to maintain consistency.

Inherited from Object.

Implementation

external int get hashCode;

runtimeType no setter inherited

Type get runtimeType

A representation of the runtime type of the object.

Inherited from Object.

Implementation

external Type get runtimeType;

value no setter

num get value

Return a unitless, numerical value of this CSS value.

Implementation

num get value => this._value;

Methods

noSuchMethod() inherited

dynamic noSuchMethod(Invocation invocation)

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Object.

Implementation

@pragma("vm:entry-point")
@pragma("wasm:entry-point")
external dynamic noSuchMethod(Invocation invocation);

toString() override

String toString()

Print out the CSS String representation of this value.

Implementation

String toString() {
  return '${_value}${_unit}';
}

Operators

operator ==() inherited

bool operator ==(Object other)

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

• Total: It must return a boolean for all arguments. It should never throw.

• Reflexive: For all objects o, o == o must be true.

• Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.

• Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

Inherited from Object.

Implementation

external bool operator ==(Object other);