Class: Browser::DOM::Element::Form

Inherits:

Browser::DOM::Element

• Object
• Node
• Browser::DOM::Element
• Browser::DOM::Element::Form

Defined in:

opal/browser/dom/element/form.rb

Constant Summary

Constants inherited from Browser::DOM::Element

Img

Constants inherited from Node

Node::ATTRIBUTE_NODE, Node::CDATA_SECTION_NODE, Node::COMMENT_NODE, Node::DOCUMENT_FRAGMENT_NODE, Node::DOCUMENT_NODE, Node::DOCUMENT_TYPE_NODE, Node::ELEMENT_NODE, Node::ENTITY_NODE, Node::ENTITY_REFERENCE_NOCE, Node::NOTATION_NODE, Node::PROCESSING_INSTRUCTION_NODE, Node::TEXT_NODE

Instance Attribute Summary

Attributes inherited from Browser::DOM::Element

#attribute_nodes, #attributes, #class_name, #class_names, #editable, #height, #id, #inner_html, #offset, #outer_html, #position, #scroll, #size, #style!, #width, #window

Attributes inherited from Node

#child, #children, #document, #element_children, #first_element_child, #last_element_child, #name, #namespace, #next, #next_element, #node_type, #outer_html, #parent, #previous, #previous_element, #value

Instance Method Summary

• #ajax_submit(&block) ⇒ Object

  Submit a form using AJAX.

• #controls ⇒ Object

  Return a NodeSet containing all form controls belonging to this form element.

• #form_data ⇒ FormData

  Capture the content of this form to a new FormData object,.

• #request_submit(submitter = nil) ⇒ Object

  Submit a form, optionally with a button argument.

• #reset ⇒ Object

  Reset a form.

• #submit ⇒ Object

  Submit a form.

• #valid? ⇒ Boolean

  Returns true if form is valid, false otherwise.

Methods inherited from Browser::DOM::Element

#/, #=~, #[], #[]=, #add_class, #animate, #animation_queue, #at, #at_css, #at_xpath, #blur, #click, create, #css, #data, def_selector, #edit, #editable?, #fade_in, #fade_out, #fade_toggle, #focus, #focused?, #hide, #inner_dom, #inner_dom=, #inspect, native_is?, native_matches?, new, #remove_attribute, #remove_class, #search, selector, #shadow, #shadow?, #show, #slide_down, #slide_toggle, #slide_up, #style, subclasses, tag_name, #toggle, #toggle_class, #visible?, #xpath

Methods included from Event::Target

#off, #on, #on!, #one, #trigger, #trigger!

Methods inherited from Node

#<<, #==, #>>, #add_child, #add_next_sibling, #add_previous_sibling, #ancestors, #append_to, #attached?, #blank?, #cdata?, #clear, #comment?, #content, #content=, #custom?, #document?, #elem?, #fragment?, #initialize, #initialize_copy, new, #parse, #path, #prepend_to, #remove, #remove_child, #replace, #text?, #traverse

Methods included from NativeCachedWrapper

#restricted?, #set_native_reference

Constructor Details

This class inherits a constructor from Browser::DOM::Node

Instance Method Details

#ajax_submit(&block) ⇒ Object

Submit a form using AJAX.

# File 'opal/browser/dom/element/form.rb', line 36

def ajax_submit(&block)
  data = form_data
  data = data.to_h unless encoding == 'multipart/form-data'
  HTTP.send(method, target, form_data, &block)
end

#controls ⇒ Object

Return a NodeSet containing all form controls belonging to this form element.

# File 'opal/browser/dom/element/form.rb', line 57

def controls
  NodeSet[Native::Array.new(`#@native.elements`)]
end

#form_data ⇒ FormData

Capture the content of this form to a new FormData object,

Returns:

• (FormData)

# File 'opal/browser/dom/element/form.rb', line 11

def form_data
  FormData.create(self)
end

#request_submit(submitter = nil) ⇒ Object

Submit a form, optionally with a button argument. This will fire a submit event.

# File 'opal/browser/dom/element/form.rb', line 27

def request_submit(submitter = nil)
  if submitter
    `#@native.requestSubmit(#{submitter.to_n})`
  else
    `#@native.requestSubmit()`
  end
end

#reset ⇒ Object

Reset a form. This will fire a reset event.

# File 'opal/browser/dom/element/form.rb', line 43

def reset
  `#@native.reset()`
end

#submit ⇒ Object

Submit a form. This will NOT fire a submit event.

# File 'opal/browser/dom/element/form.rb', line 21

def submit
  `#@native.submit()`
end

#valid? ⇒ Boolean

Returns true if form is valid, false otherwise

Returns:

• (Boolean)

# File 'opal/browser/dom/element/form.rb', line 16

def valid?
  `#@native.reportValidity()`
end