Documentation generator: JsDoc Toolkit 2.4.0
Template: Codeview 1.2
Generated on: 2012-8-29 23:29

Namespace vorple.button

Buttons and button groups

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Field Summary
Field Attributes Field Name and Description
<static>  
vorple.button.defaults
Default settings

Method Summary

Method Attributes Method Name and Description
<static>  
vorple.button.add(newButtons)
<static>  
vorple.button.Button(content, onclick, options)
Standard HTML buttons.
<static>  
vorple.button.contains(button)
<static>  
vorple.button.disable()
<static>  
vorple.button.enable()
<static>  
vorple.button.Group(buttons, parent)
Button groups.
<static>  
vorple.button.html()
<static>  
vorple.button.Image(content, onclick, options)
Image buttons.
<static>  
vorple.button.Link(content, onclick, options)
Link (<a> tag) buttons.
<static>  
vorple.button.template(content, onclick, options)
Button templates
<static>  
vorple.button.update(newButtons, preserveOrder)

Namespace Detail

vorple.button

Field Detail

<static> vorple.button.defaults
Default settings

Method Detail

  • <static> vorple.button.add(newButtons)
    Parameters:
    newButtons
  • <static> vorple.button.Button(content, onclick, options)
    Standard HTML buttons.
    Parameters:
    content
    onclick
    options
    See:
    vorple.button.template
  • <static> vorple.button.contains(button)
    Parameters:
    button
  • <static> vorple.button.disable()
  • <static> vorple.button.enable()
  • <static> vorple.button.Group(buttons, parent)
    Button groups.
    Parameters:
    {Button|jQuery|string|Array|null} buttons Optional
    Initial content of the group. Either a single button object, the HTML code of a button, a jQuery element, or an array of buttons. Passing null or leaving the parameter out will create the group as initially empty.
    {Object} parent Optional
    The main container for the button group (the parent of all buttons). If a jQuery object is given, it will be used as is. If a string is given, an element is created with the string as its class. If an object is given, an element is created using the attributes defined in the object. The default is vorple.button.defaults.groupParent (<div>).
  • <static> vorple.button.html()
  • <static> vorple.button.Image(content, onclick, options)
    Image buttons. Give the image's URL as the content, as with vorple.media.image(). You can give an alternative image that is used when the button is disabled as the disabledImage option.
    Parameters:
    content
    onclick
    options
    See:
    vorple.button.template
    vorple.media.image
  • Link (<a> tag) buttons. Note that disabled link buttons can't be enabled later on.
    Parameters:
    content
    onclick
    options
    See:
    vorple.button.template
  • <static> vorple.button.template(content, onclick, options)
    Button templates
    Parameters:
    content
    onclick
    options
  • <static> vorple.button.update(newButtons, preserveOrder)
    Parameters:
    newButtons
    preserveOrder