diff --git a/api/api.js b/api/api.js index ff8d44432e..eb06cafc29 100644 --- a/api/api.js +++ b/api/api.js @@ -9,10 +9,12 @@ YUI.add("yuidoc-meta", function(Y) { "ButtonH2", "ButtonImage", "ButtonLeft", + "ButtonOl", "ButtonRight", "ButtonStrong", "ButtonTwitter", "ButtonU", + "ButtonUl", "CKEDITOR.Link", "CKEDITOR.plugins.dropimages", "CKEDITOR.plugins.linktooltip", diff --git a/api/classes/AlloyEditor.html b/api/classes/AlloyEditor.html index 602aa1ce51..f56120f056 100644 --- a/api/classes/AlloyEditor.html +++ b/api/classes/AlloyEditor.html @@ -73,6 +73,8 @@

APIs

  • ButtonLeft
  • +
  • ButtonOl
  • +
  • ButtonRight
  • ButtonStrong
  • @@ -81,6 +83,8 @@

    APIs

  • ButtonU
  • +
  • ButtonUl
  • +
  • CKEDITOR.Link
  • CKEDITOR.plugins.dropimages
  • diff --git a/api/classes/ButtonA.html b/api/classes/ButtonA.html index 6721a6e5f2..a397db5d6f 100644 --- a/api/classes/ButtonA.html +++ b/api/classes/ButtonA.html @@ -73,6 +73,8 @@

    APIs

  • ButtonLeft
  • +
  • ButtonOl
  • +
  • ButtonRight
  • ButtonStrong
  • @@ -81,6 +83,8 @@

    APIs

  • ButtonU
  • +
  • ButtonUl
  • +
  • CKEDITOR.Link
  • CKEDITOR.plugins.dropimages
  • diff --git a/api/classes/ButtonBase.html b/api/classes/ButtonBase.html index 7ccb40f7ed..6963711e34 100644 --- a/api/classes/ButtonBase.html +++ b/api/classes/ButtonBase.html @@ -73,6 +73,8 @@

    APIs

  • ButtonLeft
  • +
  • ButtonOl
  • +
  • ButtonRight
  • ButtonStrong
  • @@ -81,6 +83,8 @@

    APIs

  • ButtonU
  • +
  • ButtonUl
  • +
  • CKEDITOR.Link
  • CKEDITOR.plugins.dropimages
  • diff --git a/api/classes/ButtonEm.html b/api/classes/ButtonEm.html index c4c249d3e3..e26b51029f 100644 --- a/api/classes/ButtonEm.html +++ b/api/classes/ButtonEm.html @@ -73,6 +73,8 @@

    APIs

  • ButtonLeft
  • +
  • ButtonOl
  • +
  • ButtonRight
  • ButtonStrong
  • @@ -81,6 +83,8 @@

    APIs

  • ButtonU
  • +
  • ButtonUl
  • +
  • CKEDITOR.Link
  • CKEDITOR.plugins.dropimages
  • @@ -185,6 +189,8 @@

    ButtonEm Class

  • Index
  • +
  • Methods
  • +
  • Attributes
  • @@ -197,6 +203,21 @@

    ButtonEm Class

    Index

    +
    +

    Methods

    + + +
    + @@ -222,6 +243,104 @@

    Attributes

    +
    +

    Methods

    + + +
    +

    _onClick

    + + +
    + (
      + +
    • + + event + +
    • + +
    ) +
    + + + + + + + + protected + + + + + + + + + + +
    + + + +

    + + Defined in + + + + + src/ui/yui/src/buttons/button-em.js:15 + +

    + + + + + +
    + +
    +

    Applies the style of the button if its current status is pressed +and removes it otherwise.

    + +
    + + +
    +

    Parameters:

    + +
      + +
    • + + event + EventFacade + + + + +
      +

      Event that triggered when user clicked on the button.

      + +
      + + +
    • + +
    +
    + + + + + +
    + + +
    + @@ -260,7 +379,7 @@

    element

    - src/ui/yui/src/buttons/button-em.js:20 + src/ui/yui/src/buttons/button-em.js:34

    @@ -365,7 +484,7 @@

    strings

    - src/ui/yui/src/buttons/button-em.js:32 + src/ui/yui/src/buttons/button-em.js:46

    diff --git a/api/classes/ButtonH1.html b/api/classes/ButtonH1.html index a702d1425f..aacfcbd550 100644 --- a/api/classes/ButtonH1.html +++ b/api/classes/ButtonH1.html @@ -73,6 +73,8 @@

    APIs

  • ButtonLeft
  • +
  • ButtonOl
  • +
  • ButtonRight
  • ButtonStrong
  • @@ -81,6 +83,8 @@

    APIs

  • ButtonU
  • +
  • ButtonUl
  • +
  • CKEDITOR.Link
  • CKEDITOR.plugins.dropimages
  • diff --git a/api/classes/ButtonH2.html b/api/classes/ButtonH2.html index 2a589b4c5e..42664052d7 100644 --- a/api/classes/ButtonH2.html +++ b/api/classes/ButtonH2.html @@ -73,6 +73,8 @@

    APIs

  • ButtonLeft
  • +
  • ButtonOl
  • +
  • ButtonRight
  • ButtonStrong
  • @@ -81,6 +83,8 @@

    APIs

  • ButtonU
  • +
  • ButtonUl
  • +
  • CKEDITOR.Link
  • CKEDITOR.plugins.dropimages
  • diff --git a/api/classes/ButtonImage.html b/api/classes/ButtonImage.html index 9527ef81c1..4da3e24a74 100644 --- a/api/classes/ButtonImage.html +++ b/api/classes/ButtonImage.html @@ -73,6 +73,8 @@

    APIs

  • ButtonLeft
  • +
  • ButtonOl
  • +
  • ButtonRight
  • ButtonStrong
  • @@ -81,6 +83,8 @@

    APIs

  • ButtonU
  • +
  • ButtonUl
  • +
  • CKEDITOR.Link
  • CKEDITOR.plugins.dropimages
  • @@ -217,6 +221,15 @@

    Methods

    + + +
  • + _onClick +protected + + +
  • @@ -420,6 +433,97 @@

    Parameters:

    + + + +
    +

    _onClick +protected

    + + +
    + (
      + +
    • + + event + +
    • + +
    ) +
    + + + + + + + + + + + + + + + + +
    + + + +

    + + Defined in + + + + + src/ui/yui/src/buttons/button-hline.js:9 + +

    + + + + + +
    + +
    +

    Inserts a horizontal line after the current selection.

    + +
    + + +
    +

    Parameters:

    + +
      + +
    • + + event + EventFacade + + + + +
      +

      Event that triggered when user clicked on the button.

      + +
      + + +
    • + +
    +
    + + + + +
    diff --git a/api/classes/ButtonLeft.html b/api/classes/ButtonLeft.html index 9e2aafdf40..1474485187 100644 --- a/api/classes/ButtonLeft.html +++ b/api/classes/ButtonLeft.html @@ -73,6 +73,8 @@

    APIs

  • ButtonLeft
  • +
  • ButtonOl
  • +
  • ButtonRight
  • ButtonStrong
  • @@ -81,6 +83,8 @@

    APIs

  • ButtonU
  • +
  • ButtonUl
  • +
  • CKEDITOR.Link
  • CKEDITOR.plugins.dropimages
  • diff --git a/api/classes/ButtonOl.html b/api/classes/ButtonOl.html new file mode 100644 index 0000000000..760b5b3ccb --- /dev/null +++ b/api/classes/ButtonOl.html @@ -0,0 +1,546 @@ + + + + + + ButtonOl - AlloyEditor + + + + + + + + + + + + + + + + + + +
    +
    + +
    +
    + Show: + + + + + + + +
    + + +
    +
    +
    + + +
    + + + + + + + + + + + +
    + + + +
    +

    The ButtonOl class provides functionality for converting a text selection into a numbered list.

    + +
    + + + +
    + + +
    +
    +

    Index

    + + +
    +

    Methods

    + + +
    + + + + + +
    +

    Attributes

    + + +
    + + + +
    + + +
    +

    Methods

    + + +
    +

    _onClick

    + + +
    + (
      + +
    • + + event + +
    • + +
    ) +
    + + + + + + + + protected + + + + + + + + + + +
    + + + +

    + + Defined in + + + + + src/ui/yui/src/buttons/button-ol.js:14 + +

    + + + + + +
    + +
    +

    Creates a numbered list block around the current selection with the following exceptions:

    +
      +
    • If the selection is already contained inside a numbered list, it will remove the list +block and transform the list items into individual paragraphs.
    • +
    • If the selection is contained inside a bulleted list, it will switch the
        tag for an +
          tag preserving all its items. +
      + +
    + + +
    +

    Parameters:

    + +
      + +
    • + + event + EventFacade + + + + +
      +

      Event that triggered when user clicked on the button.

      + +
      + + +
    • + +
    +
    + + + + + +
    + + +
    +

    updateUI

    + + + () + + + + + + + + + + + + + + + + +
    + + + +

    + + Defined in + + + + + src/ui/yui/src/buttons/button-ol.js:31 + +

    + + + + + +
    + +
    +

    Updates the toggle status of the button. If the selection is contained inside an 'ol' block, +its status will be made active and "pressed" attribute of the button will be +set to true, otherwise, it will be set to false.

    + +
    + + + + + + +
    + + +
    + + + + + +
    +

    Attributes

    + + +
    + +

    strings

    + Object + + + + + + + + + + + + + + + +
    + + + +

    + + Defined in + + + + + src/ui/yui/src/buttons/button-ol.js:54 + +

    + + + + +
    + +
    +

    Collection of strings used to label elements of the button's UI. +ButtonOl provides string properties to specify the label of the button.

    + +
    + + +

    Default: {label: 'Numbered List'}

    + + + +
    +

    Fires event stringsChange

    + +

    + Fires when the value for the configuration attribute strings is + changed. You can listen for the event using the on method if you + wish to be notified before the attribute's value has changed, or + using the after method if you wish to be notified after the + attribute's value has changed. +

    + +
    +

    Parameters:

    + +
      +
    • + e + EventFacade + +
      + An Event Facade object with the following + attribute-specific properties added: +
      + +
        +
      • + prevVal + Any +
        The value of the attribute, prior to it being set.
        +
      • +
      • + newVal + Any +
        The value the attribute is to be set to.
        +
      • +
      • + attrName + String +
        The name of the attribute being set.
        +
      • +
      • + subAttrName + String +
        If setting a property within the attribute's value, the name of the sub-attribute property being set.
        +
      • +
      +
    • +
    +
    +
    + + + +
    + + +
    + + + +
    +
    + +
    +
    +
    +
    +
    +
    + + + + + + + + + + + + \ No newline at end of file diff --git a/api/classes/ButtonRight.html b/api/classes/ButtonRight.html index b9d26e80f1..ad4432a9fa 100644 --- a/api/classes/ButtonRight.html +++ b/api/classes/ButtonRight.html @@ -73,6 +73,8 @@

    APIs

  • ButtonLeft
  • +
  • ButtonOl
  • +
  • ButtonRight
  • ButtonStrong
  • @@ -81,6 +83,8 @@

    APIs

  • ButtonU
  • +
  • ButtonUl
  • +
  • CKEDITOR.Link
  • CKEDITOR.plugins.dropimages
  • diff --git a/api/classes/ButtonStrong.html b/api/classes/ButtonStrong.html index 783eb6e061..543830f9ee 100644 --- a/api/classes/ButtonStrong.html +++ b/api/classes/ButtonStrong.html @@ -73,6 +73,8 @@

    APIs

  • ButtonLeft
  • +
  • ButtonOl
  • +
  • ButtonRight
  • ButtonStrong
  • @@ -81,6 +83,8 @@

    APIs

  • ButtonU
  • +
  • ButtonUl
  • +
  • CKEDITOR.Link
  • CKEDITOR.plugins.dropimages
  • @@ -161,7 +165,7 @@

    ButtonStrong Class

    - Defined in: src/ui/yui/src/buttons/button-strong.js:6 + Defined in: src/ui/yui/src/buttons/button-superscript.js:6
    @@ -173,7 +177,7 @@

    ButtonStrong Class

    -

    The ButtonStrong class provides functionality for applying "strong" (bold) style to a text selection.

    +

    The ButtonStrong class provides functionality for applying superscript style to a text selection.

    @@ -184,6 +188,8 @@

    ButtonStrong Class

  • Index
  • +
  • Methods
  • +
  • Attributes
  • @@ -196,6 +202,42 @@

    ButtonStrong Class

    Index

    +
    +

    Methods

    + + +
    + @@ -209,6 +251,30 @@

    Attributes

    element +
  • + element +
  • + +
  • + element +
  • + +
  • + element +
  • + +
  • + strings +
  • + +
  • + strings +
  • + +
  • + strings +
  • +
  • strings
  • @@ -221,24 +287,126 @@

    Attributes

    +
    +

    Methods

    + + +
    +

    _onClick

    + + +
    + (
      + +
    • + + event + +
    • + +
    ) +
    + + + + + + + + protected + + + + + + + + + + +
    + + + +

    + + Defined in + + + + + src/ui/yui/src/buttons/button-strike.js:14 + +

    + -
    -

    Attributes

    +
    + +
    +

    Applies the style of this button if its current status is pressed +and removes it otherwise.

    + +
    + + +
    +

    Parameters:

    + +
      + +
    • + + event + EventFacade + + + + +
      +

      Event that triggered when user clicked on the button.

      + +
      + + +
    • + +
    +
    + + + + + +
    -
    - -

    element

    - String +
    +

    _onClick

    + + +
    + (
      + +
    • + + event + +
    • + +
    ) +
    + + protected + @@ -259,91 +427,170 @@

    element

    - src/ui/yui/src/buttons/button-strong.js:19 + src/ui/yui/src/buttons/button-strong.js:14

    +
    -

    Specifies the element (style) which this button handles.

    +

    Applies the style of this button if its current status is pressed +and removes it otherwise.

    -

    Default: 'strong'

    +
    +

    Parameters:

    + +
      + +
    • + + event + EventFacade + + + + +
      +

      Event that triggered when user clicked on the button.

      + +
      + + +
    • + +
    +
    -
    -

    Fires event elementChange

    -

    - Fires when the value for the configuration attribute element is - changed. You can listen for the event using the on method if you - wish to be notified before the attribute's value has changed, or - using the after method if you wish to be notified after the - attribute's value has changed. -

    + +
    -
    -

    Parameters:

    + +
    +

    _onClick

    -
      -
    • - e + +
      + (
        + +
      • + + event + +
      • + +
      ) +
      + + + + + + + + protected + + + + + + + + + + +
      + + + +

      + + Defined in + + + + + src/ui/yui/src/buttons/button-subscript.js:14 + +

      + + + + + +
      + +
      +

      Applies the style of this button if its current status is pressed +and removes it otherwise.

      + +
      + + +
      +

      Parameters:

      + +
        + +
      • + + event EventFacade + -
        - An Event Facade object with the following - attribute-specific properties added: -
        + -
          -
        • - prevVal - Any -
          The value of the attribute, prior to it being set.
          -
        • -
        • - newVal - Any -
          The value the attribute is to be set to.
          -
        • -
        • - attrName - String -
          The name of the attribute being set.
          -
        • -
        • - subAttrName - String -
          If setting a property within the attribute's value, the name of the sub-attribute property being set.
          -
        • -
        -
      • -
      -
      +
      +

      Event that triggered when user clicked on the button.

      + +
      + + +
    • + +
    + +
    -
    - -

    strings

    - Object +
    +

    _onClick

    + + +
    + (
      + +
    • + + event + +
    • + +
    ) +
    + + protected + @@ -364,23 +611,849 @@

    strings

    - src/ui/yui/src/buttons/button-strong.js:31 + src/ui/yui/src/buttons/button-superscript.js:14

    +
    -

    Collection of strings used to label elements of the button's UI. -ButtonStrong provides string properties to specify the label of the button.

    +

    Applies the style of this button if its current status is pressed +and removes it otherwise.

    -

    Default: {label: 'Bold'}

    +
    +

    Parameters:

    + +
      + +
    • + + event + EventFacade + + + + +
      +

      Event that triggered when user clicked on the button.

      + +
      + + +
    • + +
    +
    + + + + + +
    + + +
    + + + + + +
    +

    Attributes

    + + +
    + +

    element

    + String + + + + + + + + + + + + + + + +
    + + + +

    + + Defined in + + + + + src/ui/yui/src/buttons/button-strike.js:33 + +

    + + + + +
    + +
    +

    Specifies the element (style) which this button handles.

    + +
    + + +

    Default: 's'

    + + + +
    +

    Fires event elementChange

    + +

    + Fires when the value for the configuration attribute element is + changed. You can listen for the event using the on method if you + wish to be notified before the attribute's value has changed, or + using the after method if you wish to be notified after the + attribute's value has changed. +

    + +
    +

    Parameters:

    + +
      +
    • + e + EventFacade + +
      + An Event Facade object with the following + attribute-specific properties added: +
      + +
        +
      • + prevVal + Any +
        The value of the attribute, prior to it being set.
        +
      • +
      • + newVal + Any +
        The value the attribute is to be set to.
        +
      • +
      • + attrName + String +
        The name of the attribute being set.
        +
      • +
      • + subAttrName + String +
        If setting a property within the attribute's value, the name of the sub-attribute property being set.
        +
      • +
      +
    • +
    +
    +
    + + + +
    + + +
    + +

    element

    + String + + + + + + + + + + + + + + + +
    + + + +

    + + Defined in + + + + + src/ui/yui/src/buttons/button-strong.js:33 + +

    + + + + +
    + +
    +

    Specifies the element (style) which this button handles.

    + +
    + + +

    Default: 'strong'

    + + + +
    +

    Fires event elementChange

    + +

    + Fires when the value for the configuration attribute element is + changed. You can listen for the event using the on method if you + wish to be notified before the attribute's value has changed, or + using the after method if you wish to be notified after the + attribute's value has changed. +

    + +
    +

    Parameters:

    + +
      +
    • + e + EventFacade + +
      + An Event Facade object with the following + attribute-specific properties added: +
      + +
        +
      • + prevVal + Any +
        The value of the attribute, prior to it being set.
        +
      • +
      • + newVal + Any +
        The value the attribute is to be set to.
        +
      • +
      • + attrName + String +
        The name of the attribute being set.
        +
      • +
      • + subAttrName + String +
        If setting a property within the attribute's value, the name of the sub-attribute property being set.
        +
      • +
      +
    • +
    +
    +
    + + + +
    + + +
    + +

    element

    + String + + + + + + + + + + + + + + + +
    + + + +

    + + Defined in + + + + + src/ui/yui/src/buttons/button-subscript.js:33 + +

    + + + + +
    + +
    +

    Specifies the element (style) which this button handles.

    + +
    + + +

    Default: 'sub'

    + + + +
    +

    Fires event elementChange

    + +

    + Fires when the value for the configuration attribute element is + changed. You can listen for the event using the on method if you + wish to be notified before the attribute's value has changed, or + using the after method if you wish to be notified after the + attribute's value has changed. +

    + +
    +

    Parameters:

    + +
      +
    • + e + EventFacade + +
      + An Event Facade object with the following + attribute-specific properties added: +
      + +
        +
      • + prevVal + Any +
        The value of the attribute, prior to it being set.
        +
      • +
      • + newVal + Any +
        The value the attribute is to be set to.
        +
      • +
      • + attrName + String +
        The name of the attribute being set.
        +
      • +
      • + subAttrName + String +
        If setting a property within the attribute's value, the name of the sub-attribute property being set.
        +
      • +
      +
    • +
    +
    +
    + + + +
    + + +
    + +

    element

    + String + + + + + + + + + + + + + + + +
    + + + +

    + + Defined in + + + + + src/ui/yui/src/buttons/button-superscript.js:33 + +

    + + + + +
    + +
    +

    Specifies the element (style) which this button handles.

    + +
    + + +

    Default: 'sup'

    + + + +
    +

    Fires event elementChange

    + +

    + Fires when the value for the configuration attribute element is + changed. You can listen for the event using the on method if you + wish to be notified before the attribute's value has changed, or + using the after method if you wish to be notified after the + attribute's value has changed. +

    + +
    +

    Parameters:

    + +
      +
    • + e + EventFacade + +
      + An Event Facade object with the following + attribute-specific properties added: +
      + +
        +
      • + prevVal + Any +
        The value of the attribute, prior to it being set.
        +
      • +
      • + newVal + Any +
        The value the attribute is to be set to.
        +
      • +
      • + attrName + String +
        The name of the attribute being set.
        +
      • +
      • + subAttrName + String +
        If setting a property within the attribute's value, the name of the sub-attribute property being set.
        +
      • +
      +
    • +
    +
    +
    + + + +
    + + +
    + +

    strings

    + Object + + + + + + + + + + + + + + + +
    + + + +

    + + Defined in + + + + + src/ui/yui/src/buttons/button-strike.js:45 + +

    + + + + +
    + +
    +

    Collection of strings used to label elements of the button's UI. +ButtonStrong provides string properties to specify the label of the button.

    + +
    + + +

    Default: {label: 'Strike'}

    + + + +
    +

    Fires event stringsChange

    + +

    + Fires when the value for the configuration attribute strings is + changed. You can listen for the event using the on method if you + wish to be notified before the attribute's value has changed, or + using the after method if you wish to be notified after the + attribute's value has changed. +

    + +
    +

    Parameters:

    + +
      +
    • + e + EventFacade + +
      + An Event Facade object with the following + attribute-specific properties added: +
      + +
        +
      • + prevVal + Any +
        The value of the attribute, prior to it being set.
        +
      • +
      • + newVal + Any +
        The value the attribute is to be set to.
        +
      • +
      • + attrName + String +
        The name of the attribute being set.
        +
      • +
      • + subAttrName + String +
        If setting a property within the attribute's value, the name of the sub-attribute property being set.
        +
      • +
      +
    • +
    +
    +
    + + + +
    + + +
    + +

    strings

    + Object + + + + + + + + + + + + + + + +
    + + + +

    + + Defined in + + + + + src/ui/yui/src/buttons/button-strong.js:45 + +

    + + + + +
    + +
    +

    Collection of strings used to label elements of the button's UI. +ButtonStrong provides string properties to specify the label of the button.

    + +
    + + +

    Default: {label: 'Bold'}

    + + + +
    +

    Fires event stringsChange

    + +

    + Fires when the value for the configuration attribute strings is + changed. You can listen for the event using the on method if you + wish to be notified before the attribute's value has changed, or + using the after method if you wish to be notified after the + attribute's value has changed. +

    + +
    +

    Parameters:

    + +
      +
    • + e + EventFacade + +
      + An Event Facade object with the following + attribute-specific properties added: +
      + +
        +
      • + prevVal + Any +
        The value of the attribute, prior to it being set.
        +
      • +
      • + newVal + Any +
        The value the attribute is to be set to.
        +
      • +
      • + attrName + String +
        The name of the attribute being set.
        +
      • +
      • + subAttrName + String +
        If setting a property within the attribute's value, the name of the sub-attribute property being set.
        +
      • +
      +
    • +
    +
    +
    + + + +
    + + +
    + +

    strings

    + Object + + + + + + + + + + + + + + + +
    + + + +

    + + Defined in + + + + + src/ui/yui/src/buttons/button-subscript.js:45 + +

    + + + + +
    + +
    +

    Collection of strings used to label elements of the button's UI. +ButtonStrong provides string properties to specify the label of the button.

    + +
    + + +

    Default: {label: 'Subscript'}

    + + + +
    +

    Fires event stringsChange

    + +

    + Fires when the value for the configuration attribute strings is + changed. You can listen for the event using the on method if you + wish to be notified before the attribute's value has changed, or + using the after method if you wish to be notified after the + attribute's value has changed. +

    + +
    +

    Parameters:

    + +
      +
    • + e + EventFacade + +
      + An Event Facade object with the following + attribute-specific properties added: +
      + +
        +
      • + prevVal + Any +
        The value of the attribute, prior to it being set.
        +
      • +
      • + newVal + Any +
        The value the attribute is to be set to.
        +
      • +
      • + attrName + String +
        The name of the attribute being set.
        +
      • +
      • + subAttrName + String +
        If setting a property within the attribute's value, the name of the sub-attribute property being set.
        +
      • +
      +
    • +
    +
    +
    + + + +
    + + +
    + +

    strings

    + Object + + + + + + + + + + + + + + + +
    + + + +

    + + Defined in + + + + + src/ui/yui/src/buttons/button-superscript.js:45 + +

    + + + + +
    + +
    +

    Collection of strings used to label elements of the button's UI. +ButtonStrong provides string properties to specify the label of the button.

    + +
    + + +

    Default: {label: 'Superscript'}

    diff --git a/api/classes/ButtonTwitter.html b/api/classes/ButtonTwitter.html index bf77624b31..27f3f8b477 100644 --- a/api/classes/ButtonTwitter.html +++ b/api/classes/ButtonTwitter.html @@ -73,6 +73,8 @@

    APIs

  • ButtonLeft
  • +
  • ButtonOl
  • +
  • ButtonRight
  • ButtonStrong
  • @@ -81,6 +83,8 @@

    APIs

  • ButtonU
  • +
  • ButtonUl
  • +
  • CKEDITOR.Link
  • CKEDITOR.plugins.dropimages
  • diff --git a/api/classes/ButtonU.html b/api/classes/ButtonU.html index 74d22433a9..7dc7b8738b 100644 --- a/api/classes/ButtonU.html +++ b/api/classes/ButtonU.html @@ -73,6 +73,8 @@

    APIs

  • ButtonLeft
  • +
  • ButtonOl
  • +
  • ButtonRight
  • ButtonStrong
  • @@ -81,6 +83,8 @@

    APIs

  • ButtonU
  • +
  • ButtonUl
  • +
  • CKEDITOR.Link
  • CKEDITOR.plugins.dropimages
  • @@ -242,6 +246,8 @@

    ButtonU

  • Index
  • +
  • Methods
  • +
  • Attributes
  • @@ -254,6 +260,21 @@

    ButtonU

    Index

    +
    +

    Methods

    + + +
    + @@ -279,6 +300,104 @@

    Attributes

    +
    +

    Methods

    + + +
    +

    _onClick

    + + +
    + (
      + +
    • + + event + +
    • + +
    ) +
    + + + + + + + + protected + + + + + + + + + + +
    + + + +

    + + Defined in + + + + + src/ui/yui/src/buttons/button-underline.js:16 + +

    + + + + + +
    + +
    +

    Applies the style of this button if its current status is pressed +and removes it otherwise.

    + +
    + + +
    +

    Parameters:

    + +
      + +
    • + + event + EventFacade + + + + +
      +

      Event that triggered when user clicked on the button.

      + +
      + + +
    • + +
    +
    + + + + + +
    + + +
    + @@ -317,7 +436,7 @@

    element

    - src/ui/yui/src/buttons/button-underline.js:22 + src/ui/yui/src/buttons/button-underline.js:35

    @@ -327,7 +446,7 @@

    element

    -

    Specifies the style, which should be applied to the current selection in editor.

    +

    Specifies the element (style) which this button handles.

    @@ -422,7 +541,7 @@

    strings

    - src/ui/yui/src/buttons/button-underline.js:34 + src/ui/yui/src/buttons/button-underline.js:47

    diff --git a/api/classes/ButtonUl.html b/api/classes/ButtonUl.html new file mode 100644 index 0000000000..6c1451735e --- /dev/null +++ b/api/classes/ButtonUl.html @@ -0,0 +1,546 @@ + + + + + + ButtonUl - AlloyEditor + + + + + + + + + + + + + + + + + + +
    +
    + +
    +
    + Show: + + + + + + + +
    + + +
    +
    +
    + + +
    + + + + + + + + + + + +
    + + + +
    +

    The ButtonUl class provides functionality for converting a text selection into a bulleted list.

    + +
    + + + +
    + + +
    +
    +

    Index

    + + +
    +

    Methods

    + + +
    + + + + + +
    +

    Attributes

    + + +
    + + + +
    + + +
    +

    Methods

    + + +
    +

    _onClick

    + + +
    + (
      + +
    • + + event + +
    • + +
    ) +
    + + + + + + + + protected + + + + + + + + + + +
    + + + +

    + + Defined in + + + + + src/ui/yui/src/buttons/button-ul.js:14 + +

    + + + + + +
    + +
    +

    Creates a bulleted list block around the current selection with the following exceptions:

    +
      +
    • If the selection is already contained inside a bulleted list, it will remove the list +block and transform the list items into individual paragraphs.
    • +
    • If the selection is contained inside a numbered list, it will switch the
        tag for a +
          tag preserving all its items. +
        + +
    + + +
    +

    Parameters:

    + +
      + +
    • + + event + EventFacade + + + + +
      +

      Event that triggered when user clicked on the button.

      + +
      + + +
    • + +
    +
    + + + + + +
    + + +
    +

    updateUI

    + + + () + + + + + + + + + + + + + + + + +
    + + + +

    + + Defined in + + + + + src/ui/yui/src/buttons/button-ul.js:31 + +

    + + + + + +
    + +
    +

    Updates the toggle status of the button. If the selection is contained inside an 'ul' block, +its status will be made active and "pressed" attribute of the button will be +set to true, otherwise, it will be set to false.

    + +
    + + + + + + +
    + + +
    + + + + + +
    +

    Attributes

    + + +
    + +

    strings

    + Object + + + + + + + + + + + + + + + +
    + + + +

    + + Defined in + + + + + src/ui/yui/src/buttons/button-ul.js:54 + +

    + + + + +
    + +
    +

    Collection of strings used to label elements of the button's UI. +ButtonUl provides string properties to specify the label of the button.

    + +
    + + +

    Default: {label: 'Bulleted List'}

    + + + +
    +

    Fires event stringsChange

    + +

    + Fires when the value for the configuration attribute strings is + changed. You can listen for the event using the on method if you + wish to be notified before the attribute's value has changed, or + using the after method if you wish to be notified after the + attribute's value has changed. +

    + +
    +

    Parameters:

    + +
      +
    • + e + EventFacade + +
      + An Event Facade object with the following + attribute-specific properties added: +
      + +
        +
      • + prevVal + Any +
        The value of the attribute, prior to it being set.
        +
      • +
      • + newVal + Any +
        The value the attribute is to be set to.
        +
      • +
      • + attrName + String +
        The name of the attribute being set.
        +
      • +
      • + subAttrName + String +
        If setting a property within the attribute's value, the name of the sub-attribute property being set.
        +
      • +
      +
    • +
    +
    +
    + + + +
    + + +
    + + + +
    +
    + +
    +
    +
    +
    +
    +
    + + + + + + + + + + + + \ No newline at end of file diff --git a/api/classes/CKEDITOR.Link.html b/api/classes/CKEDITOR.Link.html index d0cb3e5c1b..0879a9fcaf 100644 --- a/api/classes/CKEDITOR.Link.html +++ b/api/classes/CKEDITOR.Link.html @@ -73,6 +73,8 @@

    APIs

  • ButtonLeft
  • +
  • ButtonOl
  • +
  • ButtonRight
  • ButtonStrong
  • @@ -81,6 +83,8 @@

    APIs

  • ButtonU
  • +
  • ButtonUl
  • +
  • CKEDITOR.Link
  • CKEDITOR.plugins.dropimages
  • diff --git a/api/classes/CKEDITOR.plugins.dropimages.html b/api/classes/CKEDITOR.plugins.dropimages.html index 1e63afa4d6..7778450621 100644 --- a/api/classes/CKEDITOR.plugins.dropimages.html +++ b/api/classes/CKEDITOR.plugins.dropimages.html @@ -73,6 +73,8 @@

    APIs

  • ButtonLeft
  • +
  • ButtonOl
  • +
  • ButtonRight
  • ButtonStrong
  • @@ -81,6 +83,8 @@

    APIs

  • ButtonU
  • +
  • ButtonUl
  • +
  • CKEDITOR.Link
  • CKEDITOR.plugins.dropimages
  • diff --git a/api/classes/CKEDITOR.plugins.linktooltip.html b/api/classes/CKEDITOR.plugins.linktooltip.html index 2e7ecd8e5f..dfa014c6e9 100644 --- a/api/classes/CKEDITOR.plugins.linktooltip.html +++ b/api/classes/CKEDITOR.plugins.linktooltip.html @@ -73,6 +73,8 @@

    APIs

  • ButtonLeft
  • +
  • ButtonOl
  • +
  • ButtonRight
  • ButtonStrong
  • @@ -81,6 +83,8 @@

    APIs

  • ButtonU
  • +
  • ButtonUl
  • +
  • CKEDITOR.Link
  • CKEDITOR.plugins.dropimages
  • diff --git a/api/classes/CKEDITOR.plugins.placeholder.html b/api/classes/CKEDITOR.plugins.placeholder.html index 8420efe594..3b69a3fec1 100644 --- a/api/classes/CKEDITOR.plugins.placeholder.html +++ b/api/classes/CKEDITOR.plugins.placeholder.html @@ -73,6 +73,8 @@

    APIs

  • ButtonLeft
  • +
  • ButtonOl
  • +
  • ButtonRight
  • ButtonStrong
  • @@ -81,6 +83,8 @@

    APIs

  • ButtonU
  • +
  • ButtonUl
  • +
  • CKEDITOR.Link
  • CKEDITOR.plugins.dropimages
  • diff --git a/api/classes/CKEDITOR.plugins.selectionregion.html b/api/classes/CKEDITOR.plugins.selectionregion.html index 34a2a565cd..67b90de3f6 100644 --- a/api/classes/CKEDITOR.plugins.selectionregion.html +++ b/api/classes/CKEDITOR.plugins.selectionregion.html @@ -73,6 +73,8 @@

    APIs

  • ButtonLeft
  • +
  • ButtonOl
  • +
  • ButtonRight
  • ButtonStrong
  • @@ -81,6 +83,8 @@

    APIs

  • ButtonU
  • +
  • ButtonUl
  • +
  • CKEDITOR.Link
  • CKEDITOR.plugins.dropimages
  • diff --git a/api/classes/CKEDITOR.plugins.uicore.html b/api/classes/CKEDITOR.plugins.uicore.html index 6fa4f5a420..8ebeb1aa22 100644 --- a/api/classes/CKEDITOR.plugins.uicore.html +++ b/api/classes/CKEDITOR.plugins.uicore.html @@ -73,6 +73,8 @@

    APIs

  • ButtonLeft
  • +
  • ButtonOl
  • +
  • ButtonRight
  • ButtonStrong
  • @@ -81,6 +83,8 @@

    APIs

  • ButtonU
  • +
  • ButtonUl
  • +
  • CKEDITOR.Link
  • CKEDITOR.plugins.dropimages
  • diff --git a/api/classes/CKEDITOR.plugins.uiloader.html b/api/classes/CKEDITOR.plugins.uiloader.html index da72654ddb..0805dadbec 100644 --- a/api/classes/CKEDITOR.plugins.uiloader.html +++ b/api/classes/CKEDITOR.plugins.uiloader.html @@ -73,6 +73,8 @@

    APIs

  • ButtonLeft
  • +
  • ButtonOl
  • +
  • ButtonRight
  • ButtonStrong
  • @@ -81,6 +83,8 @@

    APIs

  • ButtonU
  • +
  • ButtonUl
  • +
  • CKEDITOR.Link
  • CKEDITOR.plugins.dropimages
  • diff --git a/api/classes/CKEDITOR.tools.html b/api/classes/CKEDITOR.tools.html index 035c56a42e..dbf254f2b0 100644 --- a/api/classes/CKEDITOR.tools.html +++ b/api/classes/CKEDITOR.tools.html @@ -73,6 +73,8 @@

    APIs

  • ButtonLeft
  • +
  • ButtonOl
  • +
  • ButtonRight
  • ButtonStrong
  • @@ -81,6 +83,8 @@

    APIs

  • ButtonU
  • +
  • ButtonUl
  • +
  • CKEDITOR.Link
  • CKEDITOR.plugins.dropimages
  • diff --git a/api/classes/LinkTooltip.html b/api/classes/LinkTooltip.html index f44eae0acd..3145386b07 100644 --- a/api/classes/LinkTooltip.html +++ b/api/classes/LinkTooltip.html @@ -73,6 +73,8 @@

    APIs

  • ButtonLeft
  • +
  • ButtonOl
  • +
  • ButtonRight
  • ButtonStrong
  • @@ -81,6 +83,8 @@

    APIs

  • ButtonU
  • +
  • ButtonUl
  • +
  • CKEDITOR.Link
  • CKEDITOR.plugins.dropimages
  • diff --git a/api/classes/ToolbarAdd.html b/api/classes/ToolbarAdd.html index 7c78453849..784433faf1 100644 --- a/api/classes/ToolbarAdd.html +++ b/api/classes/ToolbarAdd.html @@ -73,6 +73,8 @@

    APIs

  • ButtonLeft
  • +
  • ButtonOl
  • +
  • ButtonRight
  • ButtonStrong
  • @@ -81,6 +83,8 @@

    APIs

  • ButtonU
  • +
  • ButtonUl
  • +
  • CKEDITOR.Link
  • CKEDITOR.plugins.dropimages
  • diff --git a/api/classes/ToolbarAddTrigger.html b/api/classes/ToolbarAddTrigger.html index 77d1efcad6..80477725dc 100644 --- a/api/classes/ToolbarAddTrigger.html +++ b/api/classes/ToolbarAddTrigger.html @@ -73,6 +73,8 @@

    APIs

  • ButtonLeft
  • +
  • ButtonOl
  • +
  • ButtonRight
  • ButtonStrong
  • @@ -81,6 +83,8 @@

    APIs

  • ButtonU
  • +
  • ButtonUl
  • +
  • CKEDITOR.Link
  • CKEDITOR.plugins.dropimages
  • diff --git a/api/classes/ToolbarBase.html b/api/classes/ToolbarBase.html index 21fbeb1e3b..64baf1ffa1 100644 --- a/api/classes/ToolbarBase.html +++ b/api/classes/ToolbarBase.html @@ -73,6 +73,8 @@

    APIs

  • ButtonLeft
  • +
  • ButtonOl
  • +
  • ButtonRight
  • ButtonStrong
  • @@ -81,6 +83,8 @@

    APIs

  • ButtonU
  • +
  • ButtonUl
  • +
  • CKEDITOR.Link
  • CKEDITOR.plugins.dropimages
  • diff --git a/api/classes/ToolbarImage.html b/api/classes/ToolbarImage.html index 993ba58158..fcd329ff8e 100644 --- a/api/classes/ToolbarImage.html +++ b/api/classes/ToolbarImage.html @@ -73,6 +73,8 @@

    APIs

  • ButtonLeft
  • +
  • ButtonOl
  • +
  • ButtonRight
  • ButtonStrong
  • @@ -81,6 +83,8 @@

    APIs

  • ButtonU
  • +
  • ButtonUl
  • +
  • CKEDITOR.Link
  • CKEDITOR.plugins.dropimages
  • diff --git a/api/classes/ToolbarPosition.html b/api/classes/ToolbarPosition.html index f54f74598b..652a97cf60 100644 --- a/api/classes/ToolbarPosition.html +++ b/api/classes/ToolbarPosition.html @@ -73,6 +73,8 @@

    APIs

  • ButtonLeft
  • +
  • ButtonOl
  • +
  • ButtonRight
  • ButtonStrong
  • @@ -81,6 +83,8 @@

    APIs

  • ButtonU
  • +
  • ButtonUl
  • +
  • CKEDITOR.Link
  • CKEDITOR.plugins.dropimages
  • diff --git a/api/classes/ToolbarStyles.html b/api/classes/ToolbarStyles.html index 81b2746aab..35aa876b6e 100644 --- a/api/classes/ToolbarStyles.html +++ b/api/classes/ToolbarStyles.html @@ -73,6 +73,8 @@

    APIs

  • ButtonLeft
  • +
  • ButtonOl
  • +
  • ButtonRight
  • ButtonStrong
  • @@ -81,6 +83,8 @@

    APIs

  • ButtonU
  • +
  • ButtonUl
  • +
  • CKEDITOR.Link
  • CKEDITOR.plugins.dropimages
  • diff --git a/api/data.json b/api/data.json index 55e85ecf2a..18f4da44cb 100644 --- a/api/data.json +++ b/api/data.json @@ -121,6 +121,13 @@ "fors": {}, "namespaces": {} }, + "src/ui/yui/src/buttons/button-hline.js": { + "name": "src/ui/yui/src/buttons/button-hline.js", + "modules": {}, + "classes": {}, + "fors": {}, + "namespaces": {} + }, "src/ui/yui/src/buttons/button-image.js": { "name": "src/ui/yui/src/buttons/button-image.js", "modules": {}, @@ -139,6 +146,15 @@ "fors": {}, "namespaces": {} }, + "src/ui/yui/src/buttons/button-ol.js": { + "name": "src/ui/yui/src/buttons/button-ol.js", + "modules": {}, + "classes": { + "ButtonOl": 1 + }, + "fors": {}, + "namespaces": {} + }, "src/ui/yui/src/buttons/button-right.js": { "name": "src/ui/yui/src/buttons/button-right.js", "modules": {}, @@ -148,9 +164,30 @@ "fors": {}, "namespaces": {} }, + "src/ui/yui/src/buttons/button-strike.js": { + "name": "src/ui/yui/src/buttons/button-strike.js", + "modules": {}, + "classes": {}, + "fors": {}, + "namespaces": {} + }, "src/ui/yui/src/buttons/button-strong.js": { "name": "src/ui/yui/src/buttons/button-strong.js", "modules": {}, + "classes": {}, + "fors": {}, + "namespaces": {} + }, + "src/ui/yui/src/buttons/button-subscript.js": { + "name": "src/ui/yui/src/buttons/button-subscript.js", + "modules": {}, + "classes": {}, + "fors": {}, + "namespaces": {} + }, + "src/ui/yui/src/buttons/button-superscript.js": { + "name": "src/ui/yui/src/buttons/button-superscript.js", + "modules": {}, "classes": { "ButtonStrong": 1 }, @@ -166,6 +203,15 @@ "fors": {}, "namespaces": {} }, + "src/ui/yui/src/buttons/button-ul.js": { + "name": "src/ui/yui/src/buttons/button-ul.js", + "modules": {}, + "classes": { + "ButtonUl": 1 + }, + "fors": {}, + "namespaces": {} + }, "src/ui/yui/src/buttons/button-underline.js": { "name": "src/ui/yui/src/buttons/button-underline.js", "modules": {}, @@ -421,6 +467,18 @@ "line": 6, "description": "The ButtonLeft class provides functionality for changing the alignment of an image." }, + "ButtonOl": { + "name": "ButtonOl", + "shortname": "ButtonOl", + "classitems": [], + "plugins": [], + "extensions": [], + "plugin_for": [], + "extension_for": [], + "file": "src/ui/yui/src/buttons/button-ol.js", + "line": 6, + "description": "The ButtonOl class provides functionality for converting a text selection into a numbered list." + }, "ButtonRight": { "name": "ButtonRight", "shortname": "ButtonRight", @@ -441,9 +499,9 @@ "extensions": [], "plugin_for": [], "extension_for": [], - "file": "src/ui/yui/src/buttons/button-strong.js", + "file": "src/ui/yui/src/buttons/button-superscript.js", "line": 6, - "description": "The ButtonStrong class provides functionality for applying \"strong\" (bold) style to a text selection." + "description": "The ButtonStrong class provides functionality for applying superscript style to a text selection." }, "ButtonTwitter": { "name": "ButtonTwitter", @@ -457,6 +515,18 @@ "line": 6, "description": "The ButtonTwitter class provides functionality for sending tweets based on the selected text." }, + "ButtonUl": { + "name": "ButtonUl", + "shortname": "ButtonUl", + "classitems": [], + "plugins": [], + "extensions": [], + "plugin_for": [], + "extension_for": [], + "file": "src/ui/yui/src/buttons/button-ul.js", + "line": 6, + "description": "The ButtonUl class provides functionality for converting a text selection into a bulleted list." + }, "ButtonU": { "name": "ButtonU", "shortname": "ButtonU", @@ -1852,7 +1922,24 @@ }, { "file": "src/ui/yui/src/buttons/button-em.js", - "line": 20, + "line": 15, + "description": "Applies the style of the button if its current status is pressed\nand removes it otherwise.", + "itemtype": "method", + "name": "_onClick", + "access": "protected", + "tagname": "", + "params": [ + { + "name": "event", + "description": "Event that triggered when user clicked on the button.", + "type": "EventFacade" + } + ], + "class": "ButtonEm" + }, + { + "file": "src/ui/yui/src/buttons/button-em.js", + "line": 34, "description": "Specifies the element (style) which this button handles.", "itemtype": "attribute", "name": "element", @@ -1862,7 +1949,7 @@ }, { "file": "src/ui/yui/src/buttons/button-em.js", - "line": 32, + "line": 46, "description": "Collection of strings used to label elements of the button's UI.\nButtonEm provides string properties to specify the label of the button.", "itemtype": "attribute", "name": "strings", @@ -1910,6 +1997,21 @@ "type": "Object", "class": "ButtonH2" }, + { + "file": "src/ui/yui/src/buttons/button-hline.js", + "line": 9, + "description": "Inserts a horizontal line after the current selection.", + "itemtype": "method", + "name": "_onClick\nprotected", + "params": [ + { + "name": "event", + "description": "Event that triggered when user clicked on the button.", + "type": "EventFacade" + } + ], + "class": "ButtonImage" + }, { "file": "src/ui/yui/src/buttons/button-image.js", "line": 12, @@ -2028,6 +2130,41 @@ "type": "Object", "class": "ButtonLeft" }, + { + "file": "src/ui/yui/src/buttons/button-ol.js", + "line": 14, + "description": "Creates a numbered list block around the current selection with the following exceptions:\n- If the selection is already contained inside a numbered list, it will remove the list\nblock and transform the list items into individual paragraphs.\n- If the selection is contained inside a bulleted list, it will switch the