162e4179fc
We parse the arguments that come in, but since we don't yet track scrollable overflow, we can't do the full "scroll an element into view" algorithm. For now, we just call out to the PageClient and ask it to bring the nearest principal box into the visible viewport.
199 lines
7.9 KiB
C++
199 lines
7.9 KiB
C++
/*
|
|
* Copyright (c) 2018-2021, Andreas Kling <kling@serenityos.org>
|
|
*
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <AK/FlyString.h>
|
|
#include <AK/String.h>
|
|
#include <LibWeb/Bindings/ElementPrototype.h>
|
|
#include <LibWeb/CSS/CSSStyleDeclaration.h>
|
|
#include <LibWeb/CSS/StyleComputer.h>
|
|
#include <LibWeb/DOM/Attr.h>
|
|
#include <LibWeb/DOM/ChildNode.h>
|
|
#include <LibWeb/DOM/NamedNodeMap.h>
|
|
#include <LibWeb/DOM/NonDocumentTypeChildNode.h>
|
|
#include <LibWeb/DOM/ParentNode.h>
|
|
#include <LibWeb/DOM/QualifiedName.h>
|
|
#include <LibWeb/HTML/AttributeNames.h>
|
|
#include <LibWeb/HTML/EventLoop/Task.h>
|
|
#include <LibWeb/HTML/TagNames.h>
|
|
#include <LibWeb/Layout/Node.h>
|
|
#include <LibWeb/Layout/TreeBuilder.h>
|
|
#include <LibWeb/WebIDL/ExceptionOr.h>
|
|
|
|
namespace Web::DOM {
|
|
|
|
// https://w3c.github.io/csswg-drafts/cssom-view-1/#dictdef-scrolloptions
|
|
struct ScrollOptions {
|
|
Bindings::ScrollBehavior behavior { Bindings::ScrollBehavior::Auto };
|
|
};
|
|
|
|
// https://w3c.github.io/csswg-drafts/cssom-view-1/#dictdef-scrollintoviewoptions
|
|
struct ScrollIntoViewOptions : public ScrollOptions {
|
|
Bindings::ScrollLogicalPosition block { Bindings::ScrollLogicalPosition::Start };
|
|
Bindings::ScrollLogicalPosition inline_ { Bindings::ScrollLogicalPosition::Nearest };
|
|
};
|
|
|
|
class Element
|
|
: public ParentNode
|
|
, public ChildNode<Element>
|
|
, public NonDocumentTypeChildNode<Element> {
|
|
WEB_PLATFORM_OBJECT(Element, ParentNode);
|
|
|
|
public:
|
|
virtual ~Element() override;
|
|
|
|
String const& qualified_name() const { return m_qualified_name.as_string(); }
|
|
String const& html_uppercased_qualified_name() const { return m_html_uppercased_qualified_name; }
|
|
virtual FlyString node_name() const final { return html_uppercased_qualified_name(); }
|
|
FlyString const& local_name() const { return m_qualified_name.local_name(); }
|
|
|
|
// NOTE: This is for the JS bindings
|
|
String const& tag_name() const { return html_uppercased_qualified_name(); }
|
|
|
|
FlyString const& prefix() const { return m_qualified_name.prefix(); }
|
|
FlyString const& namespace_() const { return m_qualified_name.namespace_(); }
|
|
|
|
// NOTE: This is for the JS bindings
|
|
FlyString const& namespace_uri() const { return namespace_(); }
|
|
|
|
bool has_attribute(FlyString const& name) const;
|
|
bool has_attributes() const { return !m_attributes->is_empty(); }
|
|
String attribute(FlyString const& name) const { return get_attribute(name); }
|
|
String get_attribute(FlyString const& name) const;
|
|
WebIDL::ExceptionOr<void> set_attribute(FlyString const& name, String const& value);
|
|
WebIDL::ExceptionOr<void> set_attribute_ns(FlyString const& namespace_, FlyString const& qualified_name, String const& value);
|
|
void remove_attribute(FlyString const& name);
|
|
WebIDL::ExceptionOr<bool> toggle_attribute(FlyString const& name, Optional<bool> force);
|
|
size_t attribute_list_size() const { return m_attributes->length(); }
|
|
NamedNodeMap const* attributes() const { return m_attributes.ptr(); }
|
|
Vector<String> get_attribute_names() const;
|
|
|
|
DOMTokenList* class_list();
|
|
|
|
WebIDL::ExceptionOr<bool> matches(StringView selectors) const;
|
|
WebIDL::ExceptionOr<DOM::Element const*> closest(StringView selectors) const;
|
|
|
|
int client_top() const;
|
|
int client_left() const;
|
|
int client_width() const;
|
|
int client_height() const;
|
|
|
|
template<typename Callback>
|
|
void for_each_attribute(Callback callback) const
|
|
{
|
|
for (size_t i = 0; i < m_attributes->length(); ++i) {
|
|
auto const* attribute = m_attributes->item(i);
|
|
callback(attribute->name(), attribute->value());
|
|
}
|
|
}
|
|
|
|
bool has_class(FlyString const&, CaseSensitivity = CaseSensitivity::CaseSensitive) const;
|
|
Vector<FlyString> const& class_names() const { return m_classes; }
|
|
|
|
virtual void apply_presentational_hints(CSS::StyleProperties&) const { }
|
|
virtual void parse_attribute(FlyString const& name, String const& value);
|
|
virtual void did_remove_attribute(FlyString const&);
|
|
|
|
enum class NeedsRelayout {
|
|
No = 0,
|
|
Yes = 1,
|
|
};
|
|
NeedsRelayout recompute_style();
|
|
|
|
Layout::NodeWithStyle* layout_node() { return static_cast<Layout::NodeWithStyle*>(Node::layout_node()); }
|
|
Layout::NodeWithStyle const* layout_node() const { return static_cast<Layout::NodeWithStyle const*>(Node::layout_node()); }
|
|
|
|
String name() const { return attribute(HTML::AttributeNames::name); }
|
|
|
|
CSS::StyleProperties const* computed_css_values() const { return m_computed_css_values.ptr(); }
|
|
void set_computed_css_values(RefPtr<CSS::StyleProperties> style) { m_computed_css_values = move(style); }
|
|
NonnullRefPtr<CSS::StyleProperties> resolved_css_values();
|
|
|
|
CSS::CSSStyleDeclaration const* inline_style() const;
|
|
|
|
CSS::CSSStyleDeclaration* style_for_bindings();
|
|
|
|
String inner_html() const;
|
|
WebIDL::ExceptionOr<void> set_inner_html(String const&);
|
|
|
|
WebIDL::ExceptionOr<void> insert_adjacent_html(String position, String text);
|
|
|
|
bool is_focused() const;
|
|
bool is_active() const;
|
|
|
|
JS::NonnullGCPtr<HTMLCollection> get_elements_by_class_name(FlyString const&);
|
|
|
|
ShadowRoot* shadow_root() { return m_shadow_root.ptr(); }
|
|
ShadowRoot const* shadow_root() const { return m_shadow_root.ptr(); }
|
|
void set_shadow_root(JS::GCPtr<ShadowRoot>);
|
|
|
|
void set_custom_properties(HashMap<FlyString, CSS::StyleProperty> custom_properties) { m_custom_properties = move(custom_properties); }
|
|
HashMap<FlyString, CSS::StyleProperty> const& custom_properties() const { return m_custom_properties; }
|
|
|
|
void queue_an_element_task(HTML::Task::Source, JS::SafeFunction<void()>);
|
|
|
|
bool is_void_element() const;
|
|
bool serializes_as_void() const;
|
|
|
|
JS::NonnullGCPtr<Geometry::DOMRect> get_bounding_client_rect() const;
|
|
JS::NonnullGCPtr<Geometry::DOMRectList> get_client_rects() const;
|
|
|
|
virtual RefPtr<Layout::Node> create_layout_node(NonnullRefPtr<CSS::StyleProperties>);
|
|
|
|
virtual void did_receive_focus() { }
|
|
virtual void did_lose_focus() { }
|
|
|
|
static RefPtr<Layout::Node> create_layout_node_for_display_type(DOM::Document&, CSS::Display const&, NonnullRefPtr<CSS::StyleProperties>, Element*);
|
|
|
|
void set_pseudo_element_node(Badge<Layout::TreeBuilder>, CSS::Selector::PseudoElement, RefPtr<Layout::Node>);
|
|
RefPtr<Layout::Node> get_pseudo_element_node(CSS::Selector::PseudoElement) const;
|
|
void clear_pseudo_element_nodes(Badge<Layout::TreeBuilder>);
|
|
void serialize_pseudo_elements_as_json(JsonArraySerializer<StringBuilder>& children_array) const;
|
|
|
|
bool is_actually_disabled() const;
|
|
|
|
WebIDL::ExceptionOr<JS::GCPtr<Element>> insert_adjacent_element(String const& where, JS::NonnullGCPtr<Element> element);
|
|
WebIDL::ExceptionOr<void> insert_adjacent_text(String const& where, String const& data);
|
|
|
|
// https://w3c.github.io/csswg-drafts/cssom-view-1/#dom-element-scrollintoview
|
|
void scroll_into_view(Optional<Variant<bool, ScrollIntoViewOptions>>);
|
|
|
|
protected:
|
|
Element(Document&, DOM::QualifiedName);
|
|
virtual void initialize(JS::Realm&) override;
|
|
|
|
virtual void children_changed() override;
|
|
|
|
virtual void visit_edges(Cell::Visitor&) override;
|
|
|
|
private:
|
|
void make_html_uppercased_qualified_name();
|
|
|
|
WebIDL::ExceptionOr<JS::GCPtr<Node>> insert_adjacent(String const& where, JS::NonnullGCPtr<Node> node);
|
|
|
|
QualifiedName m_qualified_name;
|
|
String m_html_uppercased_qualified_name;
|
|
|
|
JS::GCPtr<NamedNodeMap> m_attributes;
|
|
JS::GCPtr<CSS::ElementInlineCSSStyleDeclaration> m_inline_style;
|
|
JS::GCPtr<DOMTokenList> m_class_list;
|
|
JS::GCPtr<ShadowRoot> m_shadow_root;
|
|
|
|
RefPtr<CSS::StyleProperties> m_computed_css_values;
|
|
HashMap<FlyString, CSS::StyleProperty> m_custom_properties;
|
|
|
|
Vector<FlyString> m_classes;
|
|
|
|
Array<RefPtr<Layout::Node>, CSS::Selector::PseudoElementCount> m_pseudo_element_nodes;
|
|
};
|
|
|
|
template<>
|
|
inline bool Node::fast_is<Element>() const { return is_element(); }
|
|
|
|
WebIDL::ExceptionOr<QualifiedName> validate_and_extract(JS::Realm&, FlyString namespace_, FlyString qualified_name);
|
|
|
|
}
|