The `Document` parameter is used only for creating the DOM event. Therefore, it does not need to be held by the caller. However, using `MOZ_KnownLive` may lead misunderstanding of the developers. Therefore, we should hide the `MOZ_KnownLive` into the overloads if the event target can access the document quickly. Differential Revision: https://phabricator.services.mozilla.com/D311669
309 lines
11 KiB
C++
309 lines
11 KiB
C++
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
#include "nsComboboxControlFrame.h"
|
|
|
|
#include <algorithm>
|
|
|
|
#include "gfxContext.h"
|
|
#include "mozilla/Likely.h"
|
|
#include "mozilla/PresShell.h"
|
|
#include "mozilla/PresShellInlines.h"
|
|
#include "mozilla/ReflowInput.h"
|
|
#include "mozilla/dom/Document.h"
|
|
#include "mozilla/dom/HTMLSelectElement.h"
|
|
#include "nsContentUtils.h"
|
|
#include "nsITheme.h"
|
|
#include "nsLayoutUtils.h"
|
|
#include "nsStyleConsts.h"
|
|
#include "nsTextFrameUtils.h"
|
|
#include "nsTextRunTransformations.h"
|
|
|
|
using namespace mozilla;
|
|
using namespace mozilla::gfx;
|
|
|
|
// Drop down list event management.
|
|
// The combo box uses the following strategy for managing the drop-down list.
|
|
// If the combo box or its arrow button is clicked on the drop-down list is
|
|
// displayed If mouse exits the combo box with the drop-down list displayed the
|
|
// drop-down list is asked to capture events The drop-down list will capture all
|
|
// events including mouse down and up and will always return with
|
|
// ListWasSelected method call regardless of whether an item in the list was
|
|
// actually selected.
|
|
// The ListWasSelected code will turn off mouse-capture for the drop-down list.
|
|
// The drop-down list does not explicitly set capture when it is in the
|
|
// drop-down mode.
|
|
|
|
nsComboboxControlFrame* NS_NewComboboxControlFrame(PresShell* aPresShell,
|
|
ComputedStyle* aStyle) {
|
|
return new (aPresShell)
|
|
nsComboboxControlFrame(aStyle, aPresShell->GetPresContext());
|
|
}
|
|
|
|
NS_IMPL_FRAMEARENA_HELPERS(nsComboboxControlFrame)
|
|
|
|
nsComboboxControlFrame::nsComboboxControlFrame(ComputedStyle* aStyle,
|
|
nsPresContext* aPresContext)
|
|
: ButtonControlFrame(aStyle, aPresContext, kClassID) {}
|
|
|
|
nsComboboxControlFrame::~nsComboboxControlFrame() = default;
|
|
|
|
NS_QUERYFRAME_HEAD(nsComboboxControlFrame)
|
|
NS_QUERYFRAME_ENTRY(nsComboboxControlFrame)
|
|
NS_QUERYFRAME_TAIL_INHERITING(ButtonControlFrame)
|
|
|
|
#ifdef ACCESSIBILITY
|
|
a11y::AccType nsComboboxControlFrame::AccessibleType() {
|
|
return a11y::eHTMLComboboxType;
|
|
}
|
|
#endif
|
|
|
|
bool nsComboboxControlFrame::HasDropDownButton() const {
|
|
const nsStyleDisplay* disp = StyleDisplay();
|
|
switch (disp->EffectiveAppearance()) {
|
|
case StyleAppearance::MenulistButton:
|
|
return true;
|
|
case StyleAppearance::Menulist:
|
|
return !IsThemed(disp) ||
|
|
PresContext()->Theme()->ThemeNeedsComboboxDropmarker();
|
|
default:
|
|
return false;
|
|
}
|
|
}
|
|
|
|
nscoord nsComboboxControlFrame::DropDownButtonISize() {
|
|
if (!HasDropDownButton()) {
|
|
return 0;
|
|
}
|
|
|
|
nsPresContext* pc = PresContext();
|
|
LayoutDeviceIntSize dropdownButtonSize = pc->Theme()->GetMinimumWidgetSize(
|
|
pc, this, StyleAppearance::MozMenulistArrowButton);
|
|
return pc->DevPixelsToAppUnits(dropdownButtonSize.width);
|
|
}
|
|
|
|
int32_t nsComboboxControlFrame::CharCountOfLargestOptionForInflation() const {
|
|
uint32_t maxLength = 0;
|
|
nsAutoString label;
|
|
for (auto i : IntegerRange(Select().Options()->Length())) {
|
|
GetOptionText(i, label);
|
|
maxLength = std::max(
|
|
maxLength,
|
|
nsTextFrameUtils::ComputeApproximateLengthWithWhitespaceCompression(
|
|
label, StyleText()));
|
|
}
|
|
if (MOZ_UNLIKELY(maxLength > uint32_t(INT32_MAX))) {
|
|
return INT32_MAX;
|
|
}
|
|
return int32_t(maxLength);
|
|
}
|
|
|
|
nscoord nsComboboxControlFrame::GetLongestOptionISize(
|
|
gfxContext* aRenderingContext) const {
|
|
// Compute the width of each option's (potentially text-transformed) text,
|
|
// and use the widest one as part of our intrinsic size.
|
|
nscoord maxOptionSize = 0;
|
|
nsAutoString label;
|
|
nsAutoString transformedLabel;
|
|
RefPtr<nsFontMetrics> fm =
|
|
nsLayoutUtils::GetInflatedFontMetricsForFrame(this);
|
|
const nsStyleText* textStyle = StyleText();
|
|
auto textTransform = textStyle->mTextTransform.IsNone()
|
|
? Nothing()
|
|
: Some(textStyle->mTextTransform);
|
|
nsAtom* language = StyleFont()->mLanguage;
|
|
AutoTArray<bool, 50> charsToMergeArray;
|
|
AutoTArray<bool, 50> deletedCharsArray;
|
|
auto GetOptionSize = [&](uint32_t aIndex) -> nscoord {
|
|
GetOptionText(aIndex, label);
|
|
const nsAutoString* stringToUse = &label;
|
|
if (textTransform ||
|
|
textStyle->mWebkitTextSecurity != StyleTextSecurity::None) {
|
|
transformedLabel.Truncate();
|
|
charsToMergeArray.SetLengthAndRetainStorage(0);
|
|
deletedCharsArray.SetLengthAndRetainStorage(0);
|
|
nsCaseTransformTextRunFactory::TransformString(
|
|
label, transformedLabel, textTransform,
|
|
textStyle->TextSecurityMaskChar(),
|
|
/* aCaseTransformsOnly = */ false,
|
|
/* aUseCapitalEsZet = */ false, language, charsToMergeArray,
|
|
deletedCharsArray);
|
|
stringToUse = &transformedLabel;
|
|
}
|
|
return nsLayoutUtils::AppUnitWidthOfStringBidi(*stringToUse, this, *fm,
|
|
*aRenderingContext);
|
|
};
|
|
for (auto i : IntegerRange(Select().Options()->Length())) {
|
|
maxOptionSize = std::max(maxOptionSize, GetOptionSize(i));
|
|
}
|
|
if (maxOptionSize) {
|
|
// HACK: Add one app unit to workaround silly Netgear router styling, see
|
|
// bug 1769580. In practice since this comes from font metrics is unlikely
|
|
// to be perceivable.
|
|
maxOptionSize += 1;
|
|
}
|
|
return maxOptionSize;
|
|
}
|
|
|
|
nscoord nsComboboxControlFrame::IntrinsicISize(const IntrinsicSizeInput& aInput,
|
|
IntrinsicISizeType aType) {
|
|
Maybe<nscoord> containISize = ContainIntrinsicISize(NS_UNCONSTRAINEDSIZE);
|
|
if (containISize && *containISize != NS_UNCONSTRAINEDSIZE) {
|
|
return *containISize;
|
|
}
|
|
|
|
if (StyleUIReset()->mFieldSizing == StyleFieldSizing::Content) {
|
|
return ButtonControlFrame::IntrinsicISize(aInput, aType);
|
|
}
|
|
|
|
nscoord displayISize = 0;
|
|
if (!containISize) {
|
|
displayISize += GetLongestOptionISize(aInput.mContext);
|
|
}
|
|
|
|
// Add room for the dropmarker button (if there is one).
|
|
displayISize += DropDownButtonISize();
|
|
return displayISize;
|
|
}
|
|
|
|
dom::HTMLSelectElement& nsComboboxControlFrame::Select() const {
|
|
return *static_cast<dom::HTMLSelectElement*>(GetContent());
|
|
}
|
|
|
|
void nsComboboxControlFrame::GetOptionText(uint32_t aIndex,
|
|
nsAString& aText) const {
|
|
aText.Truncate();
|
|
if (Element* el = Select().Options()->Item(aIndex)) {
|
|
static_cast<dom::HTMLOptionElement*>(el)->GetRenderedLabel(aText);
|
|
}
|
|
}
|
|
|
|
void nsComboboxControlFrame::Reflow(nsPresContext* aPresContext,
|
|
ReflowOutput& aDesiredSize,
|
|
const ReflowInput& aReflowInput,
|
|
nsReflowStatus& aStatus) {
|
|
// We don't call MarkInReflow() here; that happens in our superclass's
|
|
// implementation of Reflow (which we invoke further down).
|
|
MOZ_ASSERT(aStatus.IsEmpty(), "Caller should pass a fresh reflow status!");
|
|
// Constraints we try to satisfy:
|
|
|
|
// 1) Default inline size of button is the vertical scrollbar size
|
|
// 2) If the inline size of button is bigger than our inline size, set
|
|
// inline size of button to 0.
|
|
// 3) Default block size of button is block size of display area
|
|
// 4) Inline size of display area is whatever is left over from our
|
|
// inline size after allocating inline size for the button.
|
|
WritingMode wm = aReflowInput.GetWritingMode();
|
|
|
|
// Check if the theme specifies a minimum size for the dropdown button
|
|
// first.
|
|
const nscoord buttonISize = DropDownButtonISize();
|
|
const auto padding = aReflowInput.ComputedLogicalPadding(wm);
|
|
|
|
// We ignore inline-end-padding (by adding it to our label box size) if we
|
|
// have a dropdown button, so that the button aligns with the end of the
|
|
// padding box.
|
|
mDisplayISize = aReflowInput.ComputedISize() - buttonISize;
|
|
if (buttonISize) {
|
|
mDisplayISize += padding.IEnd(wm);
|
|
}
|
|
|
|
ButtonControlFrame::Reflow(aPresContext, aDesiredSize, aReflowInput, aStatus);
|
|
}
|
|
|
|
void nsComboboxControlFrame::Init(nsIContent* aContent,
|
|
nsContainerFrame* aParent,
|
|
nsIFrame* aPrevInFlow) {
|
|
ButtonControlFrame::Init(aContent, aParent, aPrevInFlow);
|
|
}
|
|
|
|
bool nsComboboxControlFrame::IsDroppedDown() const {
|
|
return Select().OpenInParentProcess();
|
|
}
|
|
|
|
nsresult nsComboboxControlFrame::HandleEvent(nsPresContext* aPresContext,
|
|
WidgetGUIEvent* aEvent,
|
|
nsEventStatus* aEventStatus) {
|
|
NS_ENSURE_ARG_POINTER(aEventStatus);
|
|
|
|
if (nsEventStatus_eConsumeNoDefault == *aEventStatus) {
|
|
return NS_OK;
|
|
}
|
|
|
|
return ButtonControlFrame::HandleEvent(aPresContext, aEvent, aEventStatus);
|
|
}
|
|
|
|
namespace mozilla {
|
|
|
|
class ComboboxLabelFrame final : public nsBlockFrame {
|
|
public:
|
|
NS_DECL_QUERYFRAME
|
|
NS_DECL_FRAMEARENA_HELPERS(ComboboxLabelFrame)
|
|
|
|
#ifdef DEBUG_FRAME_DUMP
|
|
nsresult GetFrameName(nsAString& aResult) const final {
|
|
return MakeFrameName(u"ComboboxLabel"_ns, aResult);
|
|
}
|
|
#endif
|
|
|
|
void Reflow(nsPresContext* aPresContext, ReflowOutput& aDesiredSize,
|
|
const ReflowInput& aReflowInput, nsReflowStatus& aStatus) final;
|
|
|
|
public:
|
|
ComboboxLabelFrame(ComputedStyle* aStyle, nsPresContext* aPresContext)
|
|
: nsBlockFrame(aStyle, aPresContext, kClassID) {}
|
|
};
|
|
|
|
NS_QUERYFRAME_HEAD(ComboboxLabelFrame)
|
|
NS_QUERYFRAME_ENTRY(ComboboxLabelFrame)
|
|
NS_QUERYFRAME_TAIL_INHERITING(nsBlockFrame)
|
|
NS_IMPL_FRAMEARENA_HELPERS(ComboboxLabelFrame)
|
|
|
|
void ComboboxLabelFrame::Reflow(nsPresContext* aPresContext,
|
|
ReflowOutput& aDesiredSize,
|
|
const ReflowInput& aReflowInput,
|
|
nsReflowStatus& aStatus) {
|
|
MOZ_ASSERT(aStatus.IsEmpty(), "Caller should pass a fresh reflow status!");
|
|
|
|
const nsComboboxControlFrame* combobox = do_QueryFrame(GetParent());
|
|
MOZ_ASSERT(combobox, "Combobox's frame tree is wrong!");
|
|
MOZ_ASSERT(aReflowInput.ComputedPhysicalBorderPadding() == nsMargin(),
|
|
"We shouldn't have border and padding in UA!");
|
|
|
|
ReflowInput state(aReflowInput);
|
|
state.SetComputedISize(combobox->mDisplayISize);
|
|
nsBlockFrame::Reflow(aPresContext, aDesiredSize, state, aStatus);
|
|
aStatus.Reset(); // this type of frame can't be split
|
|
}
|
|
|
|
} // namespace mozilla
|
|
|
|
nsIFrame* NS_NewComboboxLabelFrame(PresShell* aPresShell,
|
|
ComputedStyle* aStyle) {
|
|
return new (aPresShell)
|
|
ComboboxLabelFrame(aStyle, aPresShell->GetPresContext());
|
|
}
|
|
|
|
void nsComboboxControlFrame::Destroy(DestroyContext& aContext) {
|
|
auto& select = Select();
|
|
if (select.OpenInParentProcess()) {
|
|
nsContentUtils::AddScriptRunner(NS_NewRunnableFunction(
|
|
"nsComboboxControlFrame::Destroy",
|
|
[element = RefPtr{&select}]() MOZ_CAN_RUN_SCRIPT_BOUNDARY_LAMBDA {
|
|
// Don't hide the dropdown if the element has another frame already,
|
|
// this prevents closing dropdowns on reframe, see bug 1440506.
|
|
//
|
|
// FIXME(emilio): The flush is needed to deal with reframes started
|
|
// from DOM node removal. But perhaps we can be a bit smarter here.
|
|
if (!element->IsCombobox() ||
|
|
!element->GetPrimaryFrame(FlushType::Frames)) {
|
|
nsContentUtils::DispatchChromeEvent(element, u"mozhidedropdown"_ns,
|
|
CanBubble::eYes,
|
|
Cancelable::eNo);
|
|
}
|
|
}));
|
|
}
|
|
ButtonControlFrame::Destroy(aContext);
|
|
}
|