-- Common event definitions as a work-around for derivation problems with CallbackRegistryMixin.
BaseScrollBoxEvents =
{
	"OnAllowScrollChanged",
	"OnSizeChanged",
	"OnScroll",
	"OnLayout",
};

BaseScrollBoxEvents = CopyValuesAsKeys(BaseScrollBoxEvents);

ScrollBoxConstants =
{
	UpdateQueued = false,
	UpdateImmediately = true,
	NoScrollInterpolation = true,
	RetainScrollPosition = true,
	DiscardScrollPosition = false,
	AlignBegin = 0,
	AlignCenter = .5,
	AlignEnd = 1,
	AlignNearest = -1,
	ScrollBegin = MathUtil.Epsilon,
	ScrollEnd = (1 - MathUtil.Epsilon),
	StopIteration = true,
	ContinueIteration = false,
	FillExtent = 0,
};

-- ScrollBoxBaseMixin includes CallbackRegistryMixin but the derived mixins are responsible
-- for generating the events.
ScrollBoxBaseMixin = CreateFromMixins(CallbackRegistryMixin, ScrollControllerMixin);

function ScrollBoxBaseMixin:OnLoad()
	CallbackRegistryMixin.OnLoad(self);
	ScrollControllerMixin.OnLoad(self);

	self.scrollInternal = GenerateClosure(self.SetScrollPercentageInternal, self);

	local scrollTarget = self:GetScrollTarget();
	scrollTarget:RegisterCallback(BaseScrollBoxEvents.OnSizeChanged, self.OnScrollTargetSizeChanged, self);

	self.Shadows:SetFrameLevel(scrollTarget:GetFrameLevel() + 2);
	self:GetUpperShadowTexture():SetAtlas(self.upperShadow, TextureKitConstants.UseAtlasSize);
	self:GetLowerShadowTexture():SetAtlas(self.lowerShadow, TextureKitConstants.UseAtlasSize);
end

function ScrollBoxBaseMixin:Init(view)
	self:SetView(view);
	self:ScrollToBegin();
end

function ScrollBoxBaseMixin:SetView(view)
	local oldDataProvider = nil;
	local oldView = self:GetView();
	if oldView then
		oldDataProvider = oldView:GetDataProvider();
		oldView:Flush();
	end

	self.view = view;
	view:SetScrollBox(self);

	local isHorizontal = view:IsHorizontal();
	self:SetHorizontal(isHorizontal);

	local upperShadowTexture = self:GetUpperShadowTexture();
	upperShadowTexture:ClearAllPoints();
	upperShadowTexture:SetPoint("TOPLEFT");
	upperShadowTexture:SetPoint(isHorizontal and "BOTTOMLEFT" or "TOPRIGHT");

	local lowerShadowTexture = self:GetLowerShadowTexture();
	lowerShadowTexture:ClearAllPoints();
	lowerShadowTexture:SetPoint(isHorizontal and "TOPRIGHT" or "BOTTOMLEFT");
	lowerShadowTexture:SetPoint(isHorizontal and "BOTTOMRIGHT" or "BOTTOMRIGHT");

	if oldDataProvider then
		view:SetDataProvider(oldDataProvider);
	end
	
	if oldView then
		self:FullUpdate(ScrollBoxConstants.UpdateImmediately);
	end
end

function ScrollBoxBaseMixin:GetView()
	return self.view;
end

function ScrollBoxBaseMixin:HasView()
	return self:GetView() ~= nil;
end

function ScrollBoxBaseMixin:GetScrollTarget()
	return self.ScrollTarget;
end

function ScrollBoxBaseMixin:OnScrollTargetSizeChanged(width, height)
	-- Biaxal layouts require a full update because any size change may
	-- require the displayed index range to be corrected.
	local view = self:GetView();
	if view and view:HasBiaxalLayout() then
		self:FullUpdate(ScrollBoxConstants.UpdateImmediately);
	end
end

function ScrollBoxBaseMixin:OnSizeChanged(width, height)
	local view = self:GetView();
	if view and view:HasBiaxalLayout() then
		self:FullUpdate(ScrollBoxConstants.UpdateImmediately);
	else
		local forceLayout = true;
		self:Update(forceLayout);
	end

	self:TriggerEvent("OnSizeChanged", width, height, self:GetVisibleExtentPercentage());
end

-- Fixme: Replace calls to FullUpdate() with Rebuild() where appropriate so that existing frames 
-- will also be reinitialized, which is probably the expectation given this function's name.
function ScrollBoxBaseMixin:FullUpdate(immediately)
	if immediately then
		self:SetScript("OnUpdate", nil);
		self:FullUpdateInternal();
	else
		local function OnUpdate(self, dt)
			self:SetScript("OnUpdate", nil);
			self:FullUpdateInternal();
		end
		self:SetScript("OnUpdate", OnUpdate);
	end
end

function ScrollBoxBaseMixin:SetUpdateLocked(locked)
	self.updateLock = locked;
end

function ScrollBoxBaseMixin:IsUpdateLocked()
	return self.updateLock;
end

function ScrollBoxBaseMixin:FullUpdateInternal()
	--[[
	Multiple measurement APIs on the ScrollBox frame can cause OnSizeChanged to be dispatched, creating a circular update
	loop when called from within FullUpdateInternal() or Update(). Update() has a lock mechanism to prevent reentrance, however
	this function removes the OnSizeChanged script complete until all updates are complete.
	]]--

	local oldOnSizeChanged = self:GetScript("OnSizeChanged");
	self:SetScript("OnSizeChanged", nil);

	--[[
	Obtain the current scroll offset before any adjustments are made to the total extent in the call
	to RecalculateDerivedExtent() below. This value is used after the new extents are calculated to
	adjust the scroll position so that the contents do not appear displaced as result of
	additions or removals in the data provider.
	]]--
	local oldScrollOffset = self:GetDerivedScrollOffset();

	--[[
	When identical element extents are not used, this will require iterating through every element
	in the data provider and calling a calculation function to obtain the total extent. While it would
	be more efficient to correct the extent based on the elements added or removed from the data provider,
	it is a difficult optimization to implement because ScrollBox utilizes multiple different data
	providers with different data structures.

	An optimization to start with might be to have each data provider implement a counter that is updated
	on any insertion, replacement, or removal. While this wouldn't provide full context about the change,
	it would serve as an indicator that the data provider was unmodified since the last update, making an
	extent calculation unnecessary. Note however that this would be a view dependent optimization as Biaxal
	views can have their extents changed as a result of width changes, regardless of the data provider
	remaining unchanged.
	]]--
	self:RecalculateDerivedExtent();

	-- After the extent is calculated, correct the scroll position to undo the displacement.
	local scrollRange = self:GetDerivedScrollRange();
	if scrollRange > 0 then
		local deltaScrollOffset = (self:GetDerivedScrollOffset() - oldScrollOffset);
		local scrollPercentage = self:GetScrollPercentage() - (deltaScrollOffset / scrollRange);
		self:SetScrollPercentageInternal(scrollPercentage, ScrollBoxConstants.NoScrollInterpolation);
	else
		self:ScrollToBegin(ScrollBoxConstants.NoScrollInterpolation);
	end
	
	self:SetPanExtentPercentage(self:CalculatePanExtentPercentage());

	local forceLayout = true;
	self:Update(forceLayout);

	self:TriggerEvent(BaseScrollBoxEvents.OnLayout);

	self:SetScript("OnSizeChanged", oldOnSizeChanged);
end

function ScrollBoxBaseMixin:Layout()
	local view = self:GetView();
	if view then
		view:Layout(self);
		
		-- No longer bothering calculating the exact extent since there wasn't a
		-- useful use case. All that is necessary is for the scroll extent to be non-zero
		-- so that any children have valid rects for measurement purposes.
		local nonZeroExtent = 1;
		self:SetFrameExtent(self:GetScrollTarget(), nonZeroExtent);
	end
end

function ScrollBoxBaseMixin:SetEdgeFadeLength(length)
	-- Each length is the size of the alpha gradient to use when more data is available to be scrolled into view
	-- Create the base vector assuming that the orientation is vertical and swap if not.
	self.edgeFade = CreateVector2D(0, math.abs(length));
	
	if self:IsHorizontal() then
		local y, x = self.edgeFade:GetXY(); -- swapped!!
		self.edgeFade:SetXY(x, y); -- do the swap.
	end
end

function ScrollBoxBaseMixin:HasEdgeFade()
	return self.edgeFade ~= nil;
end

function ScrollBoxBaseMixin:ApplyEdgeFade(...)
	if self:HasEdgeFade() then
		for i = 1, select("#", ...) do
			local strength = Saturate(select(i, ...));
			self:SetAlphaGradient(i - 1, self.edgeFade:Clone():ScaleBy(strength));
		end
	end
end

function ScrollBoxBaseMixin:CalculateEdgeFade()
	local firstStrength, secondStrength = 1, 1;
	local offset = self:GetScrollPercentage();
	if offset ~= nil then
		if offset < 0.15 then
			firstStrength = ClampedPercentageBetween(offset, 0, 0.15);
		end

		if offset > 0.85 then
			secondStrength = 1 - ClampedPercentageBetween(offset, 0.85, 1);
		end

		return firstStrength, secondStrength;
	end

	return 0, 0;
end

function ScrollBoxBaseMixin:ClearEdgeFade()
	self:ClearAlphaGradient();
	self.edgeFade = nil;
end

function ScrollBoxBaseMixin:ShouldUseShadowsForEdgeFade()
	return self.alwaysUseShadowsForEdgeFade or not self:HasEdgeFade();
end

function ScrollBoxBaseMixin:SetUseShadowsForEdgeFade(useShadows)
	self.alwaysUseShadowsForEdgeFade = useShadows;
end

function ScrollBoxBaseMixin:SetScrollTargetOffset(offset)
	local view = self:GetView();
	if view then
		local scrollTarget = self:GetScrollTarget();
		if self:IsHorizontal() then
			scrollTarget:SetPoint("TOPLEFT", self, "TOPLEFT", -offset, -self:GetTopPadding());
			scrollTarget:SetPoint("BOTTOMLEFT", self, "BOTTOMLEFT", -offset, self:GetBottomPadding());
		else
			scrollTarget:SetPoint("TOPLEFT", self, "TOPLEFT", self:GetLeftPadding(), offset);
			scrollTarget:SetPoint("TOPRIGHT", self, "TOPRIGHT", -self:GetRightPadding(), offset);
		end

		local scrollPercentage = self:GetScrollPercentage();
		self:TriggerEvent(BaseScrollBoxEvents.OnScroll, scrollPercentage, self:GetVisibleExtentPercentage(), self:GetPanExtentPercentage());

		if self:ShouldUseShadowsForEdgeFade() then
			local hasScrollableExtent = self:HasScrollableExtent();
			local showUpper = hasScrollableExtent and (scrollPercentage > ScrollBoxConstants.ScrollBegin);
			local showLower = hasScrollableExtent and self:HasScrollableExtent() and (scrollPercentage < ScrollBoxConstants.ScrollEnd);
			self:SetShadowsShown(showLower, showUpper);
		end

		self:ApplyEdgeFade(self:CalculateEdgeFade());
	end
end

function ScrollBoxBaseMixin:ScrollInDirection(scrollPercentage, direction)
	ScrollControllerMixin.ScrollInDirection(self, scrollPercentage, direction);

	self:Update();
end

function ScrollBoxBaseMixin:ScrollToBegin(noInterpolation)
	self:SetScrollPercentage(0, noInterpolation);
end

function ScrollBoxBaseMixin:ScrollToEnd(noInterpolation)
	self:SetScrollPercentage(1, noInterpolation);
end

function ScrollBoxBaseMixin:SetScrollPercentage(scrollPercentage, noInterpolation)
	if not ApproximatelyEqual(self:GetScrollPercentage(), scrollPercentage) then
		if not noInterpolation and self:CanInterpolateScroll() then
			self:Interpolate(scrollPercentage, self.scrollInternal);
		else
			self:SetScrollPercentageInternal(scrollPercentage);
		end
	end
end

function ScrollBoxBaseMixin:SetScrollPercentageInternal(scrollPercentage)
	ScrollControllerMixin.SetScrollPercentage(self, scrollPercentage);

	self:Update();
end

function ScrollBoxBaseMixin:GetVisibleExtentPercentage()
	local extent = self:GetExtent();
	if extent > 0 then
		return self:GetVisibleExtent() / extent;
	end
	return 0;
end

function ScrollBoxBaseMixin:GetPanExtent()
	return self:GetView():GetPanExtent(self);
end

function ScrollBoxBaseMixin:SetPanExtent(panExtent)
	self:GetView():SetPanExtent(panExtent);
end

function ScrollBoxBaseMixin:GetExtent()
	return self:GetFrameExtent(self:GetScrollTarget());
end

function ScrollBoxBaseMixin:GetVisibleExtent()
	return Round(self:GetFrameExtent(self));
end

function ScrollBoxBaseMixin:GetFrames()
	return self:GetView():GetFrames();
end

function ScrollBoxBaseMixin:GetFrameCount()
	return self:GetView():GetFrameCount();
end

function ScrollBoxBaseMixin:FindFrame(elementData)
	return self:GetView():FindFrame(elementData);
end

function ScrollBoxBaseMixin:FindFrameByPredicate(predicate)
	return self:GetView():FindFrameByPredicate(predicate);
end

function ScrollBoxBaseMixin:ScrollToFrame(frame, alignment, noInterpolation)
	local offset = self:SelectPointComponent(frame);
	local frameExtent = self:GetFrameExtent(frame);
	self:ScrollToOffsetWithAdjustment(offset, frameExtent, alignment, noInterpolation);
end

function ScrollBoxBaseMixin:CalculatePanExtentPercentage()
	local scrollRange = self:GetDerivedScrollRange();
	if scrollRange > 0 then
		return self:GetPanExtent() / scrollRange;
	end
	return 0;
end

function ScrollBoxBaseMixin:CalculateScrollPercentage()
	local scrollRange = self:GetDerivedScrollRange();
	if scrollRange > 0 then
		return self:GetDerivedScrollOffset() / scrollRange;
	end
	return 0;
end

function ScrollBoxBaseMixin:HasScrollableExtent()
	return WithinRangeExclusive(self:GetVisibleExtentPercentage(), MathUtil.Epsilon, 1 - MathUtil.Epsilon);
end

function ScrollBoxBaseMixin:SetScrollAllowed(allowScroll)
	local oldAllowScroll = self:IsScrollAllowed();
	ScrollControllerMixin.SetScrollAllowed(self, allowScroll);

	self:Update();

	if oldAllowScroll ~= allowScroll then
		self:TriggerEvent(BaseScrollBoxEvents.OnAllowScrollChanged, allowScroll);
	end
end

function ScrollBoxBaseMixin:GetDerivedScrollRange()
	local derivedExtent = self:GetDerivedExtent();
	local visibleExtent = self:GetVisibleExtent();
	return math.max(0, derivedExtent - visibleExtent);
end

function ScrollBoxBaseMixin:GetDerivedScrollOffset()
	return self:GetDerivedScrollRange() * self:GetScrollPercentage();
end

function ScrollBoxBaseMixin:SetAlignmentOverlapIgnored(ignored)
	self.alignmentOverlapIgnored = ignored;
end

function ScrollBoxBaseMixin:IsAlignmentOverlapIgnored()
	return self.alignmentOverlapIgnored;
end

function ScrollBoxBaseMixin:SanitizeAlignment(alignment, extent)
	if not self:IsAlignmentOverlapIgnored() and extent > self:GetVisibleExtent() then
		return 0;
	end
	
	return alignment and Saturate(alignment) or ScrollBoxConstants.AlignCenter;
end

function ScrollBoxBaseMixin:ScrollToOffsetWithAdjustment(offset, frameExtent, alignment, noInterpolation)
	alignment = self:SanitizeAlignment(alignment, frameExtent);
	local alignedOffset = offset + (frameExtent * alignment) - (self:GetVisibleExtent() * alignment);
	self:ScrollToOffset(alignedOffset, noInterpolation);
end

function ScrollBoxBaseMixin:ScrollToOffset(offset, noInterpolation)
	local scrollRange = self:GetDerivedScrollRange();
	if scrollRange > 0 then
		local scrollPercentage = offset / scrollRange;
		self:SetScrollPercentage(scrollPercentage, noInterpolation);
	end
end

function ScrollBoxBaseMixin:GetVisibleExtentPercentage()
	local extent = self:GetDerivedExtent();
	if extent > 0 then
		return self:GetVisibleExtent() / extent;
	end
	return 0;
end

function ScrollBoxBaseMixin:RecalculateDerivedExtent()
	local view = self:GetView();
	if view then
		return view:RecalculateExtent(self);
	end
	return 0;
end

function ScrollBoxBaseMixin:GetDerivedExtent()
	local view = self:GetView();
	if view then
		return view:GetExtent();
	end
	return 0;
end

function ScrollBoxBaseMixin:SetPadding(padding)
	self:GetView():SetPadding(padding);
end

function ScrollBoxBaseMixin:GetPadding()
	local view = self:GetView();
	if view then
		return view:GetPadding()
	end
	return nil;
end

function ScrollBoxBaseMixin:GetLeftPadding()
	local padding = self:GetPadding();
	if padding then
		return padding:GetLeft();
	end
	return 0;
end

function ScrollBoxBaseMixin:GetTopPadding()
	local padding = self:GetPadding();
	if padding then
		return padding:GetTop();
	end
	return 0;
end

function ScrollBoxBaseMixin:GetRightPadding()
	local padding = self:GetPadding();
	if padding then
		return padding:GetRight();
	end
	return 0;
end

function ScrollBoxBaseMixin:GetBottomPadding()
	local padding = self:GetPadding();
	if padding then
		return padding:GetBottom();
	end
	return 0;
end

function ScrollBoxBaseMixin:GetExtentPadding()
	return self:GetUpperPadding() + self:GetLowerPadding();
end

function ScrollBoxBaseMixin:GetUpperPadding()
	if self:IsHorizontal() then
		return self:GetLeftPadding();
	else
		return self:GetTopPadding();
	end
end

function ScrollBoxBaseMixin:GetLowerPadding()
	if self:IsHorizontal() then
		return self:GetRightPadding();
	else
		return self:GetBottomPadding();
	end
end

function ScrollBoxBaseMixin:GetLowerShadowTexture(atlas)
	return self.Shadows.Lower;
end

function ScrollBoxBaseMixin:GetUpperShadowTexture(atlas)
	return self.Shadows.Upper;
end

function ScrollBoxBaseMixin:SetLowerShadowAtlas(atlas, useAtlasSize)
	self:GetLowerShadowTexture():SetAtlas(atlas, useAtlasSize);
end

function ScrollBoxBaseMixin:SetUpperShadowAtlas(atlas, useAtlasSize)
	self:GetUpperShadowTexture():SetAtlas(atlas, useAtlasSize);
end

function ScrollBoxBaseMixin:SetShadowsShown(showLower, showUpper)
	self:GetLowerShadowTexture():SetShown(showLower);
	self:GetUpperShadowTexture():SetShown(showUpper);
end

function ScrollBoxBaseMixin:SetShadowsFrameLevel(frameLevel)
	self.Shadows:SetFrameLevel(frameLevel);
end

function ScrollBoxBaseMixin:SetShadowsScale(uiScale)
	self.Shadows:SetScale(uiScale);
end

ScrollBoxListMixin = CreateFromMixins(ScrollBoxBaseMixin);

ScrollBoxListMixin:GenerateCallbackEvents(
	{
		BaseScrollBoxEvents.OnScroll,
		BaseScrollBoxEvents.OnSizeChanged,
		BaseScrollBoxEvents.OnAllowScrollChanged,
		BaseScrollBoxEvents.OnLayout,
		"OnAcquiredFrame",
		"OnInitializedFrame",
		"OnReleasedFrame",
		"OnDataRangeChanged",
		"OnUpdate",
		"OnDataProviderReassigned",
	}
);

function ScrollBoxListMixin:Init(view)
	self:Flush();

	ScrollBoxBaseMixin.Init(self, view);
end

function ScrollBoxListMixin:SetView(view)
	local oldView = self:GetView();
	if oldView then
		oldView:UnregisterCallback(ScrollBoxListViewMixin.Event.OnDataChanged, self);
		oldView:UnregisterCallback(ScrollBoxListViewMixin.Event.OnAcquiredFrame, self);
		oldView:UnregisterCallback(ScrollBoxListViewMixin.Event.OnInitializedFrame, self);
		oldView:UnregisterCallback(ScrollBoxListViewMixin.Event.OnReleasedFrame, self);
	end

	ScrollBoxBaseMixin.SetView(self, view);

	view:RegisterCallback(ScrollBoxListViewMixin.Event.OnDataChanged, self.OnViewDataChanged, self);
	view:RegisterCallback(ScrollBoxListViewMixin.Event.OnDataProviderReassigned, self.OnViewDataProviderReassigned, self);
	view:RegisterCallback(ScrollBoxListViewMixin.Event.OnAcquiredFrame, self.OnViewAcquiredFrame, self);
	view:RegisterCallback(ScrollBoxListViewMixin.Event.OnInitializedFrame, self.OnViewInitializedFrame, self);
	view:RegisterCallback(ScrollBoxListViewMixin.Event.OnReleasedFrame, self.OnViewReleasedFrame, self);
end

function ScrollBoxListMixin:Flush()
	local view = self:GetView();
	if view then
		view:Flush();
	end
end

function ScrollBoxListMixin:ForEachFrame(func)
	return self:GetView():ForEachFrame(func);
end

function ScrollBoxListMixin:ReverseForEachFrame(func)
	self:GetView():ReverseForEachFrame(func);
end

function ScrollBoxListMixin:ForEachElementData(func)
	self:GetView():ForEachElementData(func);
end

function ScrollBoxListMixin:ReverseForEachElementData(func)
	self:GetView():ReverseForEachElementData(func);
end

function ScrollBoxListMixin:EnumerateFrames()
	return self:GetView():EnumerateFrames();
end

function ScrollBoxListMixin:ReinitializeFrames()
	self:GetView():ReinitializeFrames();
end

-- Considering doing a conversion to rename EntireRange to become Enumerate, 
-- and Enumerate to be renamed to EnumerateRange(min, max). It is a bit counter-intuitive
-- for Enumerate to do anything other than iterate the entire range, and additionally
-- confusing that this newly added EntireRange function does exactly that.
function ScrollBoxListMixin:EnumerateDataProviderEntireRange()
	return self:GetView():EnumerateDataProvider();
end

function ScrollBoxListMixin:EnumerateDataProvider(indexBegin, indexEnd)
	return self:GetView():EnumerateDataProvider(indexBegin, indexEnd);
end

function ScrollBoxListMixin:ReverseEnumerateDataProviderEntireRange()
	return self:GetView():ReverseEnumerateDataProviderEntireRange();
end

function ScrollBoxListMixin:ReverseEnumerateDataProvider(indexBegin, indexEnd)
	return self:GetView():ReverseEnumerateDataProvider(indexBegin, indexEnd);
end

function ScrollBoxListMixin:FindElementData(index)
	return self:GetView():FindElementData(index);
end

function ScrollBoxListMixin:FindElementDataByPredicate(predicate)
	return self:GetView():FindElementDataByPredicate(predicate);
end

function ScrollBoxListMixin:FindElementDataIndex(elementData)
	return self:GetView():FindElementDataIndex(elementData);
end

function ScrollBoxListMixin:FindElementDataIndexByPredicate(predicate)
	return self:GetView():FindElementDataIndexByPredicate(predicate);
end

function ScrollBoxListMixin:FindByPredicate(predicate)
	return self:GetView():FindByPredicate(predicate);
end

function ScrollBoxListMixin:FindFrameElementDataIndex(frame)
	return self:GetView():FindFrameElementDataIndex(frame);
end

function ScrollBoxListMixin:ContainsElementDataByPredicate(predicate)
	return self:GetView():ContainsElementDataByPredicate(predicate);
end

function ScrollBoxListMixin:GetDataProvider()
	return self:GetView():GetDataProvider();
end

function ScrollBoxListMixin:HasDataProvider()
	return self:GetView():HasDataProvider();
end

function ScrollBoxListMixin:RemoveDataProvider()
	self:GetView():RemoveDataProvider();
end

function ScrollBoxListMixin:FlushDataProvider()
	self:GetView():FlushDataProvider();
end

function ScrollBoxListMixin:GetDataIndexBegin()
	return self:GetView():GetDataIndexBegin();
end

function ScrollBoxListMixin:GetDataIndexEnd()
	return self:GetView():GetDataIndexEnd();
end

function ScrollBoxListMixin:IsVirtualized()
	return self:GetView():IsVirtualized();
end

function ScrollBoxListMixin:GetElementExtent(dataIndex)
	return self:GetView():GetElementExtent(dataIndex);
end

function ScrollBoxListMixin:GetExtentUntil(dataIndex)
	local extent = self:GetView():GetExtentUntil(self, dataIndex);
	return extent + self:GetUpperPadding();
end

function ScrollBoxListMixin:SetDataProvider(dataProvider, retainScrollPosition)
	local view = self:GetView();
	if not view then
		error("A view is required before assigning the data provider.");
	end
	
	view:SetDataProvider(dataProvider);

	if not retainScrollPosition then
		self:ScrollToBegin(ScrollBoxConstants.NoScrollInterpolation);
	end
end

function ScrollBoxListMixin:GetDataProviderSize()
	local view = self:GetView();
	if view then
		return view:GetDataProviderSize();
	end
	return 0;
end

function ScrollBoxListMixin:OnViewDataChanged()
	self:FullUpdate(ScrollBoxConstants.UpdateImmediately);
end

function ScrollBoxListMixin:OnViewDataProviderReassigned()
	self:TriggerEvent(ScrollBoxListMixin.Event.OnDataProviderReassigned);
end

function ScrollBoxListMixin:Rebuild(retainScrollPosition)
	local view = self:GetView();
	if view then
		self:SetDataProvider(view:GetDataProvider(), retainScrollPosition);
	end
end

function ScrollBoxListMixin:OnViewAcquiredFrame(frame, elementData, new)
	self:TriggerEvent(ScrollBoxListMixin.Event.OnAcquiredFrame, frame, elementData, new);
end

function ScrollBoxListMixin:OnViewInitializedFrame(frame, elementData)
	self:TriggerEvent(ScrollBoxListMixin.Event.OnInitializedFrame, frame, elementData);
end

function ScrollBoxListMixin:OnViewReleasedFrame(frame, oldElementData)
	self:TriggerEvent(ScrollBoxListMixin.Event.OnReleasedFrame, frame, oldElementData);
end

function ScrollBoxListMixin:IsAcquireLocked()
	local view = self:GetView();
	return view and view:IsAcquireLocked();
end

function ScrollBoxListMixin:FullUpdateInternal()
	if not self:IsAcquireLocked() then
		ScrollBoxBaseMixin.FullUpdateInternal(self);
	end
end

function ScrollBoxListMixin:Update(forceLayout)
	if self:IsUpdateLocked() or self:IsAcquireLocked() then
		return;
	end

	local view = self:GetView();
	if not view then
		return;
	end

	if not view:IsInitialized() then
		return;
	end
	
	self:SetUpdateLocked(true);

	local changed = view:ValidateDataRange(self);
	local requiresLayout = changed or forceLayout;
	if requiresLayout then
		self:Layout(self);
	end

	local derivedScrollOffset = self:GetDerivedScrollOffset();
	local dataScrollOffset = view:GetDataScrollOffset(self);
	self:SetScrollTargetOffset(derivedScrollOffset - dataScrollOffset);
	self:SetPanExtentPercentage(self:CalculatePanExtentPercentage());
	
	if changed then
		view:InvokeInitializers();

		self:TriggerEvent(ScrollBoxListMixin.Event.OnDataRangeChanged, self:GetDataIndexBegin(), self:GetDataIndexEnd());
	end

	self:TriggerEvent(ScrollBoxListMixin.Event.OnUpdate);
	
	self:SetUpdateLocked(false);
end

--[[
Be very careful calling ScrollToNearest or ScrollToElementDataIndex to be certain the index is correct.
While linear views are unlikely to misbehave, Tree views return indices differently depending on if the 
tree is skipping, or traversed past collapsed elements. If you attempt to scroll to an index of child of
a collapsed tree node, either a bounds error or an incorrect scroll will happen. For these cases, use
ScrollToElementData and ScrollToElementDataByPredicate to correctly scroll (and expand to) the desired element.
]]--

function ScrollBoxListMixin:IsScrollToDataIndexSafe()
	local view = self:GetView();
	return view and view:IsScrollToDataIndexSafe();
end

function ScrollBoxListMixin:ScrollToNearest(dataIndex, offset, noInterpolation)
	self:ScrollToElementDataIndex(dataIndex, ScrollBoxConstants.AlignNearest, offset, noInterpolation);
end

function ScrollBoxListMixin:ScrollToNearestByPredicate(predicate, offset, noInterpolation)
	self:ScrollToElementDataByPredicate(predicate, ScrollBoxConstants.AlignNearest, noInterpolation);
end

function ScrollBoxListMixin:ScrollToElementDataIndex(dataIndex, alignment, offset, noInterpolation)
	local view = self:GetView();
	if not view then
		return;
	end

	local elementData = self:FindElementData(dataIndex);
	if not elementData then
		return nil;
	end
	
	offset = offset or 0;
	alignment = alignment or ScrollBoxConstants.AlignCenter;

	local extentUntil = self:GetExtentUntil(dataIndex);
	local elementExtent = self:GetElementExtent(dataIndex);

	if alignment == ScrollBoxConstants.AlignNearest then
		local scrollOffset = self:GetDerivedScrollOffset();
		if (extentUntil + elementExtent) > (scrollOffset + self:GetVisibleExtent()) then
			alignment = ScrollBoxConstants.AlignEnd;
		elseif extentUntil < scrollOffset then
			alignment = ScrollBoxConstants.AlignBegin;
		else
			-- Already fully in view
			return;
		end
	end

	local extent = extentUntil - offset;
	self:ScrollToOffsetWithAdjustment(extent, elementExtent, alignment, noInterpolation);
	return elementData;
end

function ScrollBoxListMixin:ScrollToElementData(elementData, alignment, offset, noInterpolation)
	local view = self:GetView();
	if not view then
		return;
	end

	offset = offset or 0;
	alignment = alignment or ScrollBoxConstants.AlignCenter;

	-- Tree view must expand each of the element's ancestor nodes in order for the desired element to be displayed. 
	view:PrepareScrollToElementData(elementData);

	local dataIndex = self:FindElementDataIndex(elementData);
	if dataIndex then
		return self:ScrollToElementDataIndex(dataIndex, alignment, offset, noInterpolation);
	end
end

function ScrollBoxListMixin:ScrollToElementDataByPredicate(predicate, alignment, offset, noInterpolation)
	local view = self:GetView();
	if not view then
		return;
	end
	
	offset = offset or 0;
	alignment = alignment or ScrollBoxConstants.AlignCenter;

	-- See comment adjacent to PrepareScrollToElementData above
	view:PrepareScrollToElementDataByPredicate(predicate);

	local dataIndex = self:FindElementDataIndexByPredicate(predicate);
	if dataIndex then
		return self:ScrollToElementDataIndex(dataIndex, alignment, offset, noInterpolation);
	end
end

ScrollBoxMixin = CreateFromMixins(ScrollBoxBaseMixin);

ScrollBoxMixin:GenerateCallbackEvents(
	{
		BaseScrollBoxEvents.OnScroll,
		BaseScrollBoxEvents.OnSizeChanged,
		BaseScrollBoxEvents.OnAllowScrollChanged,
		BaseScrollBoxEvents.OnLayout,
	}
);

function ScrollBoxMixin:OnLoad()
	ScrollBoxBaseMixin.OnLoad(self);

	if not self.panExtent then
		-- Intended to still function but be noticably untuned.
		self.panExtent = 3;
	end
end

function ScrollBoxMixin:SetView(view)
	ScrollBoxBaseMixin.SetView(self, view);
	
	view:ReparentScrollChildren(self:GetChildren());

	local forceLayout = true;
	self:Update(forceLayout);
end

function ScrollBoxMixin:Update(forceLayout)
	if self:IsUpdateLocked() then
		return;
	end

	local view = self:GetView();
	if not view then
		return;
	end

	if not view:IsInitialized() then
		return;
	end

	self:SetUpdateLocked(true);
	
	if forceLayout then
		self:Layout(self);
	end

	self:SetScrollTargetOffset(self:GetDerivedScrollOffset() - view:GetDataScrollOffset(self));

	self:SetUpdateLocked(false);
end
