The OpenD Programming Language

Form

Represents a HTML form. This slightly specializes Element to add a few more convenience methods for adding and extracting form data.

Please note this object may not be used for all <form> tags.

Constructors

this
this(Document _parentDocument)

.

Members

Functions

addField
Element addField(string label, string name, string type, FormFieldOptions fieldOptions)
Element addField(string label, string name, FormFieldOptions fieldOptions)
Element addField(string label, string name, string[string] options, FormFieldOptions fieldOptions)

Overrides of the base class implementations that more confirm to *my* conventions when writing form html.

addInput
Element addInput(string name, string value, string type)

Adds a new INPUT field to the end of the form with the given attributes.

addValueArray
void addValueArray(string key, string[] arrayOfValues)

This takes an array of strings and adds hidden <input> elements for each one of them. Unlike setValue, it makes no attempt to find and modify existing elements in the form to the new values.

getField
Element[] getField(string name)

Gets the actual elements with the given name

getLabel
Element getLabel(string forId)

Grabs the <label> with the given for tag, if there is one.

getPostableData
string getPostableData()

Returns the form's contents in application/x-www-form-urlencoded format.

getValue
string getValue(string field)

Gets the value of the field; what would be given if it submitted right now. (so it handles select boxes and radio buttons too). For checkboxes, if a value isn't given, but it is checked, it returns "checked", since null and "" are indistinguishable

removeField
void removeField(string name)

Removes the given field from the form. It finds the element and knocks it right out.

setValue
void setValue(string field, string value)

Overrides of the base class implementations that more confirm to *my* conventions when writing form html.

setValue
void setValue(string field, string value, bool makeNew)

Set's the form field's value. For input boxes, this sets the value attribute. For textareas, it sets the innerText. For radio boxes and select boxes, it removes the checked/selected attribute from all, and adds it to the one matching the value. For checkboxes, if the value is non-null and not empty, it checks the box. If you set a value that doesn't exist, it throws an exception if makeNew is false. Otherwise, it makes a new input with type=hidden to keep the value.

Inherited Members

From Element

opIndex
ElementCollection opIndex(string selector)

Returns a collection of elements by selector. See: Document.opIndex

opIndex
Element opIndex(size_t index)

Returns the child node with the particular index.

requireElementById
SomeElementType requireElementById(string id, string file, size_t line)

Calls getElementById, but throws instead of returning null if the element is not found. You can also ask for a specific subclass of Element to dynamically cast to, which also throws if it cannot be done.

requireSelector
SomeElementType requireSelector(string selector, string file, size_t line)

ditto but with selectors instead of ids

optionSelector
MaybeNullElement!SomeElementType optionSelector(string selector, string file, size_t line)

If a matching selector is found, it returns that Element. Otherwise, the returned object returns null for all methods.

classes
string[] classes [@property getter]

get all the classes on this element

ClassListHelper
struct ClassListHelper

The object classList returns.

classList
inout(ClassListHelper) classList [@property getter]
classNames
alias classNames = classes

Returns a helper object to work with classes, just like javascript.

addClass
Element addClass(string c)

Adds a string to the class attribute. The class attribute is used a lot in CSS.

removeClass
Element removeClass(string c)

Removes a particular class name.

hasClass
bool hasClass(string c)

Returns whether the given class appears in this element.

addChild
Element addChild(string tagName, string childInfo, string childInfo2)
Element addChild(Element e)
Element addChild(string tagName, Element firstChild, string info2)
Element addChild(string tagName, Html innerHtml, string info2)

Family of convenience functions to quickly add a tag with some text or other relevant info (for example, it's a src for an <img> element instead of inner text). They forward to Element.make then calls appendChild.

addSibling
Element addSibling(string tagName, string childInfo, string childInfo2)
Element addSibling(Element e)

Another convenience function. Adds a child directly after the current one, returning the new child.

addChildren
void addChildren(T t)

Convenience function to append text intermixed with other children. For example: div.addChildren("You can visit my website by ", new Link("mysite.com", "clicking here"), "."); or div.addChildren("Hello, ", user.name, "!"); See also: appendHtml. This might be a bit simpler though because you don't have to think about escaping.

appendChildren
void appendChildren(Element[] children)

Appends the list of children to this element.

reparent
void reparent(Element newParent)

Removes this element form its current parent and appends it to the given newParent.

stripOut
void stripOut()

Strips this tag out of the document, putting its inner html as children of the parent.

removeFromTree
Element removeFromTree()

shorthand for this.parentNode.removeChild(this) with parentNode null check if the element already isn't in a tree, it does nothing.

wrapIn
Element wrapIn(Element what)

Wraps this element inside the given element. It's like this.replaceWith(what); what.appendchild(this);

replaceWith
Element replaceWith(Element e)

Replaces this element with something else in the tree.

firstInnerText
string firstInnerText()

Fetches the first consecutive text nodes concatenated together.

directText
string directText [@property getter]

Returns the text directly under this element.

directText
string directText [@property setter]

Sets the direct text, without modifying other child nodes.

tagName
string tagName;

The name of the tag. Remember, changing this doesn't change the dynamic type of the object.

attributes
AttributesHolder attributes;

This is where the attributes are actually stored. You should use getAttribute, setAttribute, and hasAttribute instead.

parentDocument
inout(Document) parentDocument [@property getter]

Get the parent Document object that contains this element. It may be null, so remember to check for that.

parentNode
inout(Element) parentNode()

Returns the parent node in the tree this element is attached to.

make
Element make(string tagName, string childInfo, string childInfo2, string[] selfClosedElements)
Element make(string tagName, Html innerHtml, string childInfo2)
Element make(string tagName, Element child, string childInfo2)

Convenience function to try to do the right thing for HTML. This is the main way I create elements.

firstChild
Element firstChild [@property getter]

Returns the first child of this element. If it has no children, returns null. Remember, text nodes are children too.

lastChild
Element lastChild [@property getter]

Returns the last child of the element, or null if it has no children. Remember, text nodes are children too.

nextInSource
Element nextInSource()
previousInSource
Element previousInSource()

the next or previous element you would encounter if you were reading it in the source. May be a text node or other special non-tag object if you enabled them.

previousElementSibling
Element previousElementSibling [@property getter]
nextElementSibling
Element nextElementSibling [@property getter]

Returns the next or previous sibling that is not a text node. Please note: the behavior with comments is subject to change. Currently, it will return a comment or other nodes if it is in the tree (if you enabled it with Document.enableAddingSpecialTagsToDom or Document.parseSawComment) and not if you didn't, but the implementation will probably change at some point to skip them regardless.

previousSibling
string previousSibling [@property setter]
nextSibling
string nextSibling [@property setter]

Returns the next or previous sibling matching the tagName filter. The default filter of null will return the first sibling it sees, even if it is a comment or text node, or anything else. A filter of "*" will match any tag with a name. Otherwise, the string must match the tagName of the sibling you want to find.

getParent
T getParent(string tagName)

Gets the nearest node, going up the chain, with the given tagName May return null or throw. The type T will specify a subclass like Form, Table, or Link, which it will cast for you when found.

getElementById
Element getElementById(string id)

Searches this element and the tree of elements under it for one matching the given id attribute.

querySelector
Element querySelector(string selector)

Returns a child element that matches the given selector.

matches
bool matches(string selector)

If the element matches the given selector. Previously known as matchesSelector.

closest
Element closest(string selector)

Returns itself or the closest parent that matches the given selector, or null if none found

querySelectorAll
Element[] querySelectorAll(string selector)
getElementsBySelector
alias getElementsBySelector = querySelectorAll

Returns elements that match the given CSS selector

getElementsByClassName
Element[] getElementsByClassName(string cn)
getElementsByTagName
Element[] getElementsByTagName(string tag)

Returns child elements that have the given class name or tag name.

getAttribute
string getAttribute(string name)

Gets the given attribute value, or null if the attribute is not set.

setAttribute
Element setAttribute(string name, string value)

Sets an attribute. Returns this for easy chaining

hasAttribute
bool hasAttribute(string name)

Returns if the attribute exists.

removeAttribute
Element removeAttribute(string name)

Removes the given attribute from the element.

className
string className [@property getter]
string className [@property setter]

Gets or sets the class attribute's contents. Returns an empty string if it has no class.

opDispatch
string opDispatch [@property setter]

Provides easy access to common HTML attributes, object style.

opDispatch
string opDispatch [@property setter]

Old access to attributes. Use attrs instead.

childNodes
inout(Element[]) childNodes [@property getter]

Returns the element's children.

dataset
DataSet dataset [@property getter]

HTML5's dataset property. It is an alternate view into attributes with the data- prefix. Given <a data-my-property="cool" />, we get assert(a.dataset.myProperty == "cool");

attrs
AttributeSet attrs [@property getter]

Gives dot/opIndex access to attributes

style
ElementStyle style [@property getter]

Provides both string and object style (like in Javascript) access to the style attribute.

style
string style [@property setter]

This sets the style attribute with a string.

computedStyle
CssStyle computedStyle [@property getter]

Don't use this. It can try to parse out the style element but it isn't complete and if I get back to it, it won't be for a while.

expansionHook
void* expansionHook;

These properties are useless in most cases, but if you write a layout engine on top of this lib, they may be good +////ditt

offsetWidth
int offsetWidth;

These properties are useless in most cases, but if you write a layout engine on top of this lib, they may be good +////ditt

offsetHeight
int offsetHeight;

These properties are useless in most cases, but if you write a layout engine on top of this lib, they may be good +////ditt

offsetLeft
int offsetLeft;

These properties are useless in most cases, but if you write a layout engine on top of this lib, they may be good +////ditt

offsetTop
int offsetTop;

These properties are useless in most cases, but if you write a layout engine on top of this lib, they may be good +////ditt

offsetParent
Element offsetParent;

These properties are useless in most cases, but if you write a layout engine on top of this lib, they may be good +////ditt

hasLayout
bool hasLayout;

These properties are useless in most cases, but if you write a layout engine on top of this lib, they may be good +////ditt

zIndex
int zIndex;
absoluteLeft
int absoluteLeft()
absoluteTop
int absoluteTop()

These properties are useless in most cases, but if you write a layout engine on top of this lib, they may be good +////ditt

removeAllChildren
void removeAllChildren()

Removes all inner content from the tag; all child text and elements are gone.

appendSibling
Element appendSibling(Element e)
prependSibling
Element prependSibling(Element e)

Adds a sibling element before or after this one in the dom.

appendChild
Element appendChild(Element e)

Appends the given element to this one. If it already has a parent, it is removed from that tree and moved to this one.

insertBefore
Element insertBefore(Element where, Element what)

Inserts the second element to this node, right before the first param

insertAfter
Element insertAfter(Element where, Element what)

Inserts the given element what as a sibling of the this element, after the element where in the parent node.

swapNode
Element swapNode(Element child, Element replacement)

swaps one child for a new thing. Returns the old child which is now parentless.

appendText
Element appendText(string text)

Appends the given to the node.

childElements
string childElements [@property setter]

Returns child elements which are of a tag type (excludes text, comments, etc.).

appendHtml
Element[] appendHtml(string html)

Appends the given html to the element, returning the elements appended

insertChildAfter
void insertChildAfter(Element child, Element where)

Inserts a child under this element after the element where.

stealChildren
Element[] stealChildren(Element e, Element position)

Reparents all the child elements of e to this, leaving e childless.

prependChild
Element prependChild(Element e)

Puts the current element first in our children list. The given element must not have a parent already.

innerHTML
Appender!string innerHTML [@property setter]

Returns a string containing all child elements, formatted such that it could be pasted into an XML file.

innerHTML
Element innerHTML(string html, bool strict)
Html innerHTML [@property setter]

Takes some html and replaces the element's children with the tree made from the string.

outerHTML
string outerHTML [@property setter]

Replaces this node with the given html string, which is parsed

outerHTML
string outerHTML [@property getter]

Returns all the html for this element, including the tag itself.

innerRawSource
string innerRawSource [@property setter]

This sets the inner content of the element *without* trying to parse it. You can inject any code in there; this serves as an escape hatch from the dom.

replaceChild
Element replaceChild(Element find, Element replace)

Replaces the element find, which must be a child of this, with the element replace, which must have no parent.

replaceChild
void replaceChild(Element find, Element[] replace)

Replaces the given element with a whole group.

removeChild
Element removeChild(Element c)

Removes the given child from this list.

removeChildren
Element[] removeChildren()

This removes all the children from this element, returning the old list.

innerText
string innerText [@property getter]
textContent
alias textContent = innerText

Fetch the inside text, with all tags stripped out.

visibleText
string visibleText()

Gets the element's visible text, similar to how it would look assuming the document was HTML being displayed by a browser. This means it will attempt whitespace normalization (unless it is a <pre> tag), add \n characters for <br> tags, and I reserve the right to make it process additional css and tags in the future.

innerText
string innerText [@property setter]

Sets the inside text, replacing all children. You don't have to worry about entity encoding.

outerText
string outerText [@property setter]

Strips this node out of the document, replacing it with the given text

outerText
string outerText [@property getter]

Same result as innerText; the tag with all inner tags stripped out

cloned
Element cloned [@property getter]

This is a full clone of the element. Alias for cloneNode(true) now. Don't extend it.

cloneNode
Element cloneNode(bool deepClone)

Clones the node. If deepClone is true, clone all inner tags too. If false, only do this tag (and its attributes), but it will have no contents.

nodeValue
string nodeValue()

W3C DOM interface. Only really meaningful on TextNode instances, but the interface is present on the base class.

nodeType
int nodeType [@property getter]

.

toString
string toString()

Turns the whole element, including tag, attributes, and children, into a string which could be pasted into an XML file.

isEmpty
bool isEmpty()

Returns if the node would be printed to string as <tag /> or <tag></tag>. In other words, if it has no non-empty text nodes and no element nodes. Please note that whitespace text nodes are NOT considered empty; Html("<tag> </tag>").isEmpty == false.

toPrettyString
string toPrettyString(bool insertComments, int indentationLevel, string indentWith)

Writes out with formatting. Be warned: formatting changes the contents. Use ONLY for eyeball debugging.

writeToAppender
string writeToAppender(Appender!string where)

This is the actual implementation used by toString. You can pass it a preallocated buffer to save some time. Note: the ordering of attributes in the string is undefined. Returns the string it creates.

tree
ElementStream tree [@property getter]

Returns a lazy range of all its children, recursively.

addField
Element addField(string label, string name, string type, FormFieldOptions fieldOptions)
Element addField(Element label, string name, string type, FormFieldOptions fieldOptions)
Element addField(string label, string name, FormFieldOptions fieldOptions)
Element addField(string label, string name, string[string] options, FormFieldOptions fieldOptions)
addSubmitButton
Element addSubmitButton(string label)

Adds a form field to this element, normally a <input> but type can also be "textarea".

See Also

Meta