Package org.angular.ts.ng

Interface Transition<TRouteMap,TRoutes>

@JsType(isNative=true, name="ng.Transition", namespace="<global>") public interface Transition<TRouteMap,TRoutes>
Public AngularTS Transition contract exposed through the global ng namespace for Closure-annotated applications.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    abort()
    Aborts this transition Imperative API to abort a Transition.
    void
    applyViewConfigs()
    Public Transition.applyViewConfigs member exposed by the AngularTS namespace contract.
    boolean
    dynamic()
    Returns true if the transition is dynamic.
    elemental2.core.JsArray<StateDeclaration>
    entering()
    Gets the states being entered.
    Object
    error()
    The Transition error reason.
    elemental2.core.JsArray<StateDeclaration>
    exiting()
    Gets the states being exited.
    StateDeclaration
    from()
    Returns the "from state" Returns the state that the transition is coming *from*.
    double
    getId()
    Public Transition.id member exposed by the AngularTS namespace contract.
    elemental2.promise.Promise<StateDeclaration>
    getPromise()
    Public Transition.promise member exposed by the AngularTS namespace contract.
    boolean
    isActive()
    Checks if this transition is currently active/running.
    boolean
    isSuccess()
    Public Transition.success member exposed by the AngularTS namespace contract.
    ParamsOf<TRouteMap,Object>
    params(String pathname)
    Public Transition.params member exposed by the AngularTS namespace contract.
    Transition<RouteMap,Object>
    redirect(Object targetState)
    Creates a new transition that is a redirection of the current one.
    elemental2.promise.Promise<StateDeclaration>
    run()
    Runs the transition This method is generally called from the [[StateService.transitionTo]]
    void
    setId(double id)
    Public Transition.id member exposed by the AngularTS namespace contract.
    void
    setPromise(elemental2.promise.Promise<StateDeclaration> promise)
    Public Transition.promise member exposed by the AngularTS namespace contract.
    void
    setSuccess(boolean success)
    Public Transition.success member exposed by the AngularTS namespace contract.
    StateDeclaration
    to()
    Returns the "to state" Returns the state that the transition is going *to*.
    String
    toString_()
    A string representation of the Transition
    boolean
    valid()
    Checks if the Transition is valid

  • Method Details

    • abort

      void abort()
      Aborts this transition Imperative API to abort a Transition. This only applies to Transitions that are not yet complete.

    • applyViewConfigs

      void applyViewConfigs()
      Public Transition.applyViewConfigs member exposed by the AngularTS namespace contract.

    • dynamic

      boolean dynamic()
      Returns true if the transition is dynamic. A transition is dynamic if no states are entered nor exited, but at least one dynamic parameter has changed.
      Returns:
      Method result.

    • entering

      elemental2.core.JsArray<StateDeclaration> entering()
      Gets the states being entered.
      Returns:
      Method result.

    • error

      Object error()
      The Transition error reason. If the transition is invalid (and could not be run), returns the reason the transition is invalid. If the transition was valid and ran, but was not successful, returns the reason the transition failed.
      Returns:
      Method result.

    • exiting

      elemental2.core.JsArray<StateDeclaration> exiting()
      Gets the states being exited.
      Returns:
      Method result.

    • from

      StateDeclaration from()
      Returns the "from state" Returns the state that the transition is coming *from*.
      Returns:
      Method result.

    • getId

      @JsProperty double getId()
      Public Transition.id member exposed by the AngularTS namespace contract.

    • getPromise

      @JsProperty elemental2.promise.Promise<StateDeclaration> getPromise()
      Public Transition.promise member exposed by the AngularTS namespace contract.

    • isActive

      boolean isActive()
      Checks if this transition is currently active/running.
      Returns:
      Method result.

    • isSuccess

      @JsProperty boolean isSuccess()
      Public Transition.success member exposed by the AngularTS namespace contract.

    • params

      ParamsOf<TRouteMap,Object> params(String pathname)
      Public Transition.params member exposed by the AngularTS namespace contract.
      Parameters:
      pathname - Value supplied for the pathname parameter.
      Returns:
      Method result.

    • redirect

      Transition<RouteMap,Object> redirect(Object targetState)
      Creates a new transition that is a redirection of the current one. This transition can be returned from a [[TransitionService]] hook to redirect a transition to a new state and/or set of parameters.
      Parameters:
      targetState - the new target state for the redirected transition
      Returns:
      Method result.

    • run

      elemental2.promise.Promise<StateDeclaration> run()
      Runs the transition This method is generally called from the [[StateService.transitionTo]]
      Returns:
      Method result.

    • setId

      @JsProperty void setId(double id)
      Public Transition.id member exposed by the AngularTS namespace contract.

    • setPromise

      @JsProperty void setPromise(elemental2.promise.Promise<StateDeclaration> promise)
      Public Transition.promise member exposed by the AngularTS namespace contract.

    • setSuccess

      @JsProperty void setSuccess(boolean success)
      Public Transition.success member exposed by the AngularTS namespace contract.

    • to

      StateDeclaration to()
      Returns the "to state" Returns the state that the transition is going *to*.
      Returns:
      Method result.

    • toString_

      @JsMethod(name="toString") String toString_()
      A string representation of the Transition
      Returns:
      Method result.

    • valid

      boolean valid()
      Checks if the Transition is valid
      Returns:
      Method result.