AlloyUI - API Docs

  • API Docs for Version: 3.1.0-deprecated.60

    • Show:

    A.Url Class

    Defined in: alloy-ui/src/aui-url/js/aui-url.js:43
    Module: aui-url

    A base class for A.Url.

    In order to understand what each attribute/method does, you need to see the anatomy of a URL:

     foo://example.com:8042/over/there?name=ferret#nose
                             \_/   \______________/\_________/ \_________/ \__/
                            Scheme     Authority       Path       Query   Anchor

    Constructor

    A.Url

    (
    • config
    )

    Defined in alloy-ui/src/aui-url/js/aui-url.js:43

    Parameters:

    • config Object

      Object literal specifying widget configuration properties.

    Methods

    _afterAction

    (
    • action
    )
    protected

    Provided by the aui-undo-redo module.

    Defined in alloy-ui/src/aui-undo-redo/js/aui-undo-redo.js:249

    Executes right after an action finishes running.

    Parameters:

    • action Object

      Object containing the state and action type (undo or redo) to be executed.

    _defBeforeActionFn

    (
    • event
    )
    protected

    Provided by the aui-undo-redo module.

    Defined in alloy-ui/src/aui-undo-redo/js/aui-undo-redo.js:285

    This is the default function for the beforeUndo and beforeRedo events.

    Parameters:

    _indexParameters

    () protected

    Defined in alloy-ui/src/aui-url/js/aui-url.js:568

    Indexes all parameters into the query.

    _indexParts

    (
    • url
    )
    protected

    Defined in alloy-ui/src/aui-url/js/aui-url.js:584

    Indexes all URL parts to its private attributes.

    Parameters:

    • url Object

    _makeEventName

    () String protected

    Provided by the aui-undo-redo module.

    Defined in alloy-ui/src/aui-undo-redo/js/aui-undo-redo.js:304

    Constructs the event's name based on its prefix and the action type related to it.

    Returns:

    String:

    Returns the camel case version of prefix plus actionType.

    _onRedoKey

    () EventFacade

    Provided by the aui-undo-redo module.

    Defined in alloy-ui/src/aui-undo-redo/js/aui-undo-redo.js:265

    Calls redo method on ctrl + y keydown event

    Returns:

    EventFacade:

    event

    _onUndoKey

    () EventFacade

    Provided by the aui-undo-redo module.

    Defined in alloy-ui/src/aui-undo-redo/js/aui-undo-redo.js:275

    Calls undo method on ctrl + z keydown event

    Returns:

    EventFacade:

    event

    _prevBeforeActionFn

    (
    • event
    )
    protected

    Provided by the aui-undo-redo module.

    Defined in alloy-ui/src/aui-undo-redo/js/aui-undo-redo.js:317

    This function runs when a beforeUndo or beforeRedo event is prevented.

    Parameters:

    _removeStatesBeyondMaxDepth

    () protected

    Provided by the aui-undo-redo module.

    Defined in alloy-ui/src/aui-undo-redo/js/aui-undo-redo.js:331

    Removes states in the stack if it's over the max depth limit.

    _runAction

    (
    • action
    )
    protected

    Provided by the aui-undo-redo module.

    Defined in alloy-ui/src/aui-undo-redo/js/aui-undo-redo.js:348

    Executes the given action (which can be either undo or redo).

    Parameters:

    • action Object

      Object containing the state and action type (undo or redo) to be executed.

    _runNextPendingAction

    () protected

    Provided by the aui-undo-redo module.

    Defined in alloy-ui/src/aui-undo-redo/js/aui-undo-redo.js:364

    Executes the next pending action, if one exists.

    _shouldIgnoreNewActions

    () Boolean protected

    Provided by the aui-undo-redo module.

    Defined in alloy-ui/src/aui-undo-redo/js/aui-undo-redo.js:379

    Checks if new actions (calls to undo/redo) should be ignored. Actions should only be ignored if the queueable attribute is false and there is currently an action in progress.

    Returns:

    Boolean:

    _tryMerge

    () Boolean protected

    Provided by the aui-undo-redo module.

    Defined in alloy-ui/src/aui-undo-redo/js/aui-undo-redo.js:392

    Tries to merge the given state to one at the current position in the stack.

    Returns:

    Boolean:

    Returns true if the merge happened and false otherwise.

    add

    (
    • state
    )

    Provided by the aui-undo-redo module.

    Defined in alloy-ui/src/aui-undo-redo/js/aui-undo-redo.js:111

    Adds a state to the stack and makes it the current state. Note that all states that could be redone will be removed from the stack after this. Valid states are objects that have at least 2 functions: undo and redo. These functions can return promises, in which case any subsequent calls will be queued, waiting for all pending promises to end.

    Parameters:

    • state Object | Function

      Object that contains undo and redo action methods (and, optionally, a 'merge' method).

    addParameter

    (
    • key
    • values
    )

    Defined in alloy-ui/src/aui-url/js/aui-url.js:77

    Adds a single parameter in the URL.

    Parameters:

    • key Object
    • values Object

    addParameters

    (
    • parameters
    )

    Defined in alloy-ui/src/aui-url/js/aui-url.js:92

    Adds a list of parameters in the URL.

    Parameters:

    • parameters Object

    canRedo

    () Boolean

    Provided by the aui-undo-redo module.

    Defined in alloy-ui/src/aui-undo-redo/js/aui-undo-redo.js:144

    Checks if it's possible to redo an action.

    Returns:

    Boolean:

    canUndo

    () Boolean

    Provided by the aui-undo-redo module.

    Defined in alloy-ui/src/aui-undo-redo/js/aui-undo-redo.js:154

    Checks if it's possible to undo an action.

    Returns:

    Boolean:

    clearHistory

    ()

    Provided by the aui-undo-redo module.

    Defined in alloy-ui/src/aui-undo-redo/js/aui-undo-redo.js:164

    Resets the stack, clearing all states and pending actions.

    getAnchor

    () String

    Defined in alloy-ui/src/aui-url/js/aui-url.js:144

    Gets the anchor.

    Returns:

    String:

    getAuthority

    () String

    Defined in alloy-ui/src/aui-url/js/aui-url.js:156

    Gets the authority.

    Returns:

    String:

    getDirectory

    () String

    Defined in alloy-ui/src/aui-url/js/aui-url.js:168

    Gets the directory.

    Returns:

    String:

    getFile

    () String

    Defined in alloy-ui/src/aui-url/js/aui-url.js:180

    Gets the file.

    Returns:

    String:

    getHost

    () String

    Defined in alloy-ui/src/aui-url/js/aui-url.js:192

    Gets the host.

    Returns:

    String:

    getParameter

    (
    • key
    )
    String

    Defined in alloy-ui/src/aui-url/js/aui-url.js:119

    Gets a single parameter.

    Parameters:

    • key Object

    Returns:

    String:

    getParameters

    () Array

    Defined in alloy-ui/src/aui-url/js/aui-url.js:132

    Gets a list of parameters.

    Returns:

    Array:

    getPassword

    () String

    Defined in alloy-ui/src/aui-url/js/aui-url.js:204

    Gets the password.

    Returns:

    String:

    getPath

    () String

    Defined in alloy-ui/src/aui-url/js/aui-url.js:216

    Gets the path.

    Returns:

    String:

    getPort

    () String

    Defined in alloy-ui/src/aui-url/js/aui-url.js:228

    Gets the port.

    Returns:

    String:

    getProtocol

    () String

    Defined in alloy-ui/src/aui-url/js/aui-url.js:240

    Gets the protocol.

    Returns:

    String:

    getQuery

    () String

    Defined in alloy-ui/src/aui-url/js/aui-url.js:252

    Gets the query.

    Returns:

    String:

    getRelative

    () String

    Defined in alloy-ui/src/aui-url/js/aui-url.js:264

    Gets the relative.

    Returns:

    String:

    getSource

    () String

    Defined in alloy-ui/src/aui-url/js/aui-url.js:276

    Gets the source.

    Returns:

    String:

    getUser

    () String

    Defined in alloy-ui/src/aui-url/js/aui-url.js:288

    Gets the user.

    Returns:

    String:

    getUserInfo

    () String

    Defined in alloy-ui/src/aui-url/js/aui-url.js:300

    Gets the user info.

    Returns:

    String:

    hasParameter

    (
    • key
    )
    Boolean

    Defined in alloy-ui/src/aui-url/js/aui-url.js:106

    Checks if the URL has a parameter.

    Parameters:

    • key Object

    Returns:

    Boolean:

    initializer

    () protected

    Provided by the aui-undo-redo module.

    Defined in alloy-ui/src/aui-undo-redo/js/aui-undo-redo.js:74

    Constructor for the Undo/Redo component.

    isActionInProgress

    () Boolean

    Provided by the aui-undo-redo module.

    Defined in alloy-ui/src/aui-undo-redo/js/aui-undo-redo.js:175

    Checks if either an undo or a redo action is currently in progress.

    Returns:

    Boolean:

    redo

    () Boolean

    Provided by the aui-undo-redo module.

    Defined in alloy-ui/src/aui-undo-redo/js/aui-undo-redo.js:185

    Redoes the next state.

    Returns:

    Boolean:

    Returns false if there was no state to be redone and true, otherwise.

    redoPeek

    () Boolean

    Provided by the aui-undo-redo module.

    Defined in alloy-ui/src/aui-undo-redo/js/aui-undo-redo.js:207

    Returns the state that will be redone when calling redo().

    Returns:

    Boolean:

    removeParameter

    (
    • key
    )

    Defined in alloy-ui/src/aui-url/js/aui-url.js:312

    Removes a single parameter from the parameters list.

    Parameters:

    • key Object

    removeParameters

    (
    • parameters
    )

    Defined in alloy-ui/src/aui-url/js/aui-url.js:326

    Removes a list of parameters from the parameters list.

    Parameters:

    • parameters Object

    setAnchor

    (
    • val
    )

    Defined in alloy-ui/src/aui-url/js/aui-url.js:369

    Sets the anchor.

    Parameters:

    • val Object

    setAuthority

    (
    • val
    )

    Defined in alloy-ui/src/aui-url/js/aui-url.js:381

    Sets the authority.

    Parameters:

    • val Object

    setDirectory

    (
    • val
    )

    Defined in alloy-ui/src/aui-url/js/aui-url.js:393

    Sets the directory.

    Parameters:

    • val Object

    setFile

    (
    • val
    )

    Defined in alloy-ui/src/aui-url/js/aui-url.js:405

    Sets the file.

    Parameters:

    • val Object

    setHost

    (
    • val
    )

    Defined in alloy-ui/src/aui-url/js/aui-url.js:417

    Sets the host.

    Parameters:

    • val Object

    setParameter

    (
    • key
    • opt_values
    )

    Defined in alloy-ui/src/aui-url/js/aui-url.js:340

    Sets a single parameter.

    Parameters:

    • key Object
    • opt_values Object

    setParameters

    (
    • parameters
    )

    Defined in alloy-ui/src/aui-url/js/aui-url.js:355

    Sets a list of parameters.

    Parameters:

    • parameters Object

    setPassword

    (
    • val
    )

    Defined in alloy-ui/src/aui-url/js/aui-url.js:429

    Sets the password.

    Parameters:

    • val Object

    setPath

    (
    • val
    )

    Defined in alloy-ui/src/aui-url/js/aui-url.js:441

    Sets the path.

    Parameters:

    • val Object

    setPort

    (
    • val
    )

    Defined in alloy-ui/src/aui-url/js/aui-url.js:453

    Sets the port.

    Parameters:

    • val Object

    setProtocol

    (
    • val
    )

    Defined in alloy-ui/src/aui-url/js/aui-url.js:465

    Sets the protocol.

    Parameters:

    • val Object

    setRelative

    (
    • val
    )

    Defined in alloy-ui/src/aui-url/js/aui-url.js:477

    Sets the relative.

    Parameters:

    • val Object

    setSource

    (
    • val
    )

    Defined in alloy-ui/src/aui-url/js/aui-url.js:489

    Sets the source.

    Parameters:

    • val Object

    setUser

    (
    • val
    )

    Defined in alloy-ui/src/aui-url/js/aui-url.js:501

    Sets the user.

    Parameters:

    • val Object

    setUserInfo

    (
    • val
    )

    Defined in alloy-ui/src/aui-url/js/aui-url.js:513

    Sets the user info.

    Parameters:

    • val Object

    toString

    () String

    Defined in alloy-ui/src/aui-url/js/aui-url.js:525

    Generates the entire URL based on each attribute.

    Returns:

    String:

    undo

    () Boolean

    Provided by the aui-undo-redo module.

    Defined in alloy-ui/src/aui-undo-redo/js/aui-undo-redo.js:217

    Undoes the last state.

    Returns:

    Boolean:

    Returns false if there was no state to be undone and true, otherwise.

    undoPeek

    () Boolean

    Provided by the aui-undo-redo module.

    Defined in alloy-ui/src/aui-undo-redo/js/aui-undo-redo.js:239

    Returns the state that will be undone when calling undo().

    Returns:

    Boolean:

    Properties

    _currentStateIndex

    Number protected

    Provided by the aui-undo-redo module.

    Defined in alloy-ui/src/aui-undo-redo/js/aui-undo-redo.js:45

    This index points to the last state that was executed. Calling undo() will undo the state this index points to.

    _pendingActions

    Array protected

    Provided by the aui-undo-redo module.

    Defined in alloy-ui/src/aui-undo-redo/js/aui-undo-redo.js:55

    List of pending actions.

    _states

    Array protected

    Provided by the aui-undo-redo module.

    Defined in alloy-ui/src/aui-undo-redo/js/aui-undo-redo.js:64

    List of states containing undo and redo action methods added by the user through the add method.

    Attributes

    maxUndoDepth

    Number

    Provided by the aui-undo-redo module.

    Defined in alloy-ui/src/aui-undo-redo/js/aui-undo-redo.js:409

    Limits the states stack size. Useful for memory optimization.

    Default: 100

    queueable

    Boolean

    Provided by the aui-undo-redo module.

    Defined in alloy-ui/src/aui-undo-redo/js/aui-undo-redo.js:423

    Defines how this module will behave when the user calls undo or redo while an action is still in progress. If false, these calls will be ignored. If true, they will be queued, running in order as soon as the pending action finishes.

    Default: false

    Events

    afterRedo

    Provided by the aui-undo-redo module.

    Defined in alloy-ui/src/aui-undo-redo/js/aui-undo-redo.js:7

    Fired after a redo has finished running.

    afterUndo

    Provided by the aui-undo-redo module.

    Defined in alloy-ui/src/aui-undo-redo/js/aui-undo-redo.js:13

    Fired after an undo has finished running.

    beforeRedo

    Provided by the aui-undo-redo module.

    Defined in alloy-ui/src/aui-undo-redo/js/aui-undo-redo.js:19

    Fired right before a redo is run.

    beforeUndo

    Provided by the aui-undo-redo module.

    Defined in alloy-ui/src/aui-undo-redo/js/aui-undo-redo.js:26

    Fired right before an undo is run.