script/dom/html/
htmloutputelement.rs

1/* This Source Code Form is subject to the terms of the Mozilla Public
2 * License, v. 2.0. If a copy of the MPL was not distributed with this
3 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
4
5use dom_struct::dom_struct;
6use html5ever::{LocalName, Prefix, local_name};
7use js::context::JSContext;
8use js::rust::HandleObject;
9
10use crate::dom::attr::Attr;
11use crate::dom::bindings::cell::DomRefCell;
12use crate::dom::bindings::codegen::Bindings::HTMLOutputElementBinding::HTMLOutputElementMethods;
13use crate::dom::bindings::inheritance::Castable;
14use crate::dom::bindings::root::{DomRoot, MutNullableDom};
15use crate::dom::bindings::str::DOMString;
16use crate::dom::document::Document;
17use crate::dom::element::{AttributeMutation, Element};
18use crate::dom::html::htmlelement::HTMLElement;
19use crate::dom::html::htmlformelement::{FormControl, HTMLFormElement};
20use crate::dom::node::{Node, NodeTraits};
21use crate::dom::nodelist::NodeList;
22use crate::dom::validation::Validatable;
23use crate::dom::validitystate::ValidityState;
24use crate::dom::virtualmethods::VirtualMethods;
25use crate::script_runtime::CanGc;
26
27#[dom_struct]
28pub(crate) struct HTMLOutputElement {
29    htmlelement: HTMLElement,
30    form_owner: MutNullableDom<HTMLFormElement>,
31    labels_node_list: MutNullableDom<NodeList>,
32    default_value_override: DomRefCell<Option<DOMString>>,
33    validity_state: MutNullableDom<ValidityState>,
34}
35
36impl HTMLOutputElement {
37    fn new_inherited(
38        local_name: LocalName,
39        prefix: Option<Prefix>,
40        document: &Document,
41    ) -> HTMLOutputElement {
42        HTMLOutputElement {
43            htmlelement: HTMLElement::new_inherited(local_name, prefix, document),
44            form_owner: Default::default(),
45            labels_node_list: Default::default(),
46            default_value_override: DomRefCell::new(None),
47            validity_state: Default::default(),
48        }
49    }
50
51    pub(crate) fn new(
52        cx: &mut js::context::JSContext,
53        local_name: LocalName,
54        prefix: Option<Prefix>,
55        document: &Document,
56        proto: Option<HandleObject>,
57    ) -> DomRoot<HTMLOutputElement> {
58        Node::reflect_node_with_proto(
59            cx,
60            Box::new(HTMLOutputElement::new_inherited(
61                local_name, prefix, document,
62            )),
63            document,
64            proto,
65        )
66    }
67
68    pub(crate) fn reset(&self, cx: &mut JSContext) {
69        Node::string_replace_all(cx, self.DefaultValue(), self.upcast::<Node>());
70        *self.default_value_override.borrow_mut() = None;
71    }
72}
73
74impl HTMLOutputElementMethods<crate::DomTypeHolder> for HTMLOutputElement {
75    /// <https://html.spec.whatwg.org/multipage/#dom-fae-form>
76    fn GetForm(&self) -> Option<DomRoot<HTMLFormElement>> {
77        self.form_owner()
78    }
79
80    // https://html.spec.whatwg.org/multipage/#dom-lfe-labels
81    make_labels_getter!(Labels, labels_node_list);
82
83    /// <https://html.spec.whatwg.org/multipage/#dom-output-defaultvaleu>
84    fn DefaultValue(&self) -> DOMString {
85        let dvo = self.default_value_override.borrow();
86        if let Some(ref dv) = *dvo {
87            dv.clone()
88        } else {
89            self.upcast::<Node>().descendant_text_content()
90        }
91    }
92
93    /// <https://html.spec.whatwg.org/multipage/#dom-output-defaultvalue>
94    fn SetDefaultValue(&self, cx: &mut JSContext, value: DOMString) {
95        if self.default_value_override.borrow().is_none() {
96            // Step 1 ("and return")
97            Node::string_replace_all(cx, value, self.upcast::<Node>());
98        } else {
99            // Step 2, if not returned from step 1
100            *self.default_value_override.borrow_mut() = Some(value);
101        }
102    }
103
104    /// <https://html.spec.whatwg.org/multipage/#dom-output-value>
105    fn Value(&self) -> DOMString {
106        self.upcast::<Node>().descendant_text_content()
107    }
108
109    /// <https://html.spec.whatwg.org/multipage/#dom-output-value>
110    fn SetValue(&self, cx: &mut JSContext, value: DOMString) {
111        *self.default_value_override.borrow_mut() = Some(self.DefaultValue());
112        Node::string_replace_all(cx, value, self.upcast::<Node>());
113    }
114
115    /// <https://html.spec.whatwg.org/multipage/#dom-output-type>
116    fn Type(&self) -> DOMString {
117        DOMString::from("output")
118    }
119
120    // https://html.spec.whatwg.org/multipage/#dom-fe-name
121    make_atomic_setter!(SetName, "name");
122
123    // https://html.spec.whatwg.org/multipage/#dom-fe-name
124    make_getter!(Name, "name");
125
126    /// <https://html.spec.whatwg.org/multipage/#dom-cva-willvalidate>
127    fn WillValidate(&self) -> bool {
128        self.is_instance_validatable()
129    }
130
131    /// <https://html.spec.whatwg.org/multipage/#dom-cva-validity>
132    fn Validity(&self, can_gc: CanGc) -> DomRoot<ValidityState> {
133        self.validity_state(can_gc)
134    }
135
136    /// <https://html.spec.whatwg.org/multipage/#dom-cva-checkvalidity>
137    fn CheckValidity(&self, cx: &mut JSContext) -> bool {
138        self.check_validity(cx)
139    }
140
141    /// <https://html.spec.whatwg.org/multipage/#dom-cva-reportvalidity>
142    fn ReportValidity(&self, cx: &mut JSContext) -> bool {
143        self.report_validity(cx)
144    }
145
146    /// <https://html.spec.whatwg.org/multipage/#dom-cva-validationmessage>
147    fn ValidationMessage(&self) -> DOMString {
148        self.validation_message()
149    }
150
151    /// <https://html.spec.whatwg.org/multipage/#dom-cva-setcustomvalidity>
152    fn SetCustomValidity(&self, error: DOMString, can_gc: CanGc) {
153        self.validity_state(can_gc).set_custom_error_message(error);
154    }
155}
156
157impl VirtualMethods for HTMLOutputElement {
158    fn super_type(&self) -> Option<&dyn VirtualMethods> {
159        Some(self.upcast::<HTMLElement>() as &dyn VirtualMethods)
160    }
161
162    fn attribute_mutated(
163        &self,
164        cx: &mut js::context::JSContext,
165        attr: &Attr,
166        mutation: AttributeMutation,
167    ) {
168        self.super_type()
169            .unwrap()
170            .attribute_mutated(cx, attr, mutation);
171        if attr.local_name() == &local_name!("form") {
172            self.form_attribute_mutated(mutation, CanGc::from_cx(cx));
173        }
174    }
175}
176
177impl FormControl for HTMLOutputElement {
178    fn form_owner(&self) -> Option<DomRoot<HTMLFormElement>> {
179        self.form_owner.get()
180    }
181
182    fn set_form_owner(&self, form: Option<&HTMLFormElement>) {
183        self.form_owner.set(form);
184    }
185
186    fn to_element(&self) -> &Element {
187        self.upcast::<Element>()
188    }
189}
190
191impl Validatable for HTMLOutputElement {
192    fn as_element(&self) -> &Element {
193        self.upcast()
194    }
195
196    fn validity_state(&self, can_gc: CanGc) -> DomRoot<ValidityState> {
197        self.validity_state
198            .or_init(|| ValidityState::new(&self.owner_window(), self.upcast(), can_gc))
199    }
200
201    fn is_instance_validatable(&self) -> bool {
202        // output is not a submittable element (https://html.spec.whatwg.org/multipage/#category-submit)
203        false
204    }
205}
script/dom/html/htmloutputelement.rs

script/dom/html/
htmloutputelement.rs
