Basalt2/src/elements/Frame.lua

local elementManager = require("elementManager")
local VisualElement = elementManager.getElement("VisualElement")
local Container = elementManager.getElement("Container")
---@configDescription A frame element that serves as a grouping container for other elements.

--- This is the frame class. It serves as a grouping container for other elements.
---@class Frame : Container
local Frame = setmetatable({}, Container)
Frame.__index = Frame

---@property draggable boolean false Whether the frame is draggable
Frame.defineProperty(Frame, "draggable", {default = false, type = "boolean"})
---@property draggingMap table {} The map of dragging positions
Frame.defineProperty(Frame, "draggingMap", {default = {{x=1, y=1, width="width", height=1}}, type = "table"})
---@property scrollable boolean false Whether the frame is scrollable
Frame.defineProperty(Frame, "scrollable", {default = false, type = "boolean"})

Frame.defineEvent(Frame, "mouse_click")
Frame.defineEvent(Frame, "mouse_drag")
Frame.defineEvent(Frame, "mouse_up")
Frame.defineEvent(Frame, "mouse_scroll")

--- Creates a new Frame instance
--- @shortDescription Creates a new Frame instance
--- @return Frame self The newly created Frame instance
--- @private
function Frame.new()
    local self = setmetatable({}, Frame):__init()
    self.class = Frame
    self.set("width", 12)
    self.set("height", 6)
    self.set("z", 10)
    return self
end

--- @shortDescription Initializes the Frame instance
--- @param props table The properties to initialize the element with
--- @param basalt table The basalt instance
--- @return Frame self The initialized instance
--- @protected
function Frame:init(props, basalt)
    Container.init(self, props, basalt)
    self.set("type", "Frame")
    return self
end

--- @shortDescription Handles mouse click events
--- @param button number The button that was clicked
--- @param x number The x position of the click
--- @param y number The y position of the click
--- @return boolean handled Whether the event was handled
--- @protected
function Frame:mouse_click(button, x, y)
    if self:isInBounds(x, y) then
        if self.getResolved("draggable") then
            local relX, relY = self:getRelativePosition(x, y)
            local draggingMap = self.getResolved("draggingMap")

            for _, map in ipairs(draggingMap) do
                local width = map.width or 1
                local height = map.height or 1

                if type(width) == "string" and width == "width" then
                    width = self.getResolved("width")
                elseif type(width) == "function" then
                    width = width(self)
                end
                if type(height) == "string" and height == "height" then
                    height = self.getResolved("height")
                elseif type(height) == "function" then
                    height = height(self)
                end

                local mapY = map.y or 1
                if relX >= map.x and relX <= map.x + width - 1 and
                relY >= mapY and relY <= mapY + height - 1 then
                    self.dragStartX = x - self.getResolved("x")
                    self.dragStartY = y - self.getResolved("y")
                    self.dragging = true
                    return true
                end
            end
        end
        return Container.mouse_click(self, button, x, y)
    end
    return false
end

--- @shortDescription Handles mouse release events
--- @param button number The button that was released
--- @param x number The x position of the release
--- @param y number The y position of the release
--- @return boolean handled Whether the event was handled
--- @protected
function Frame:mouse_up(button, x, y)
    if self.dragging then
        self.dragging = false
        self.dragStartX = nil
        self.dragStartY = nil
        return true
    end
    return Container.mouse_up(self, button, x, y)
end

--- @shortDescription Handles mouse drag events
--- @param button number The button that was clicked
--- @param x number The x position of the drag position
--- @param y number The y position of the drag position
--- @return boolean handled Whether the event was handled
--- @protected
function Frame:mouse_drag(button, x, y)
    if self.dragging then
        local newX = x - self.dragStartX
        local newY = y - self.dragStartY

        self.set("x", newX)
        self.set("y", newY)
        return true
    end
    return Container.mouse_drag(self, button, x, y)
end

--- @shortDescription Calculates the total height of all children elements
--- @return number height The total height needed for all children
--- @protected
function Frame:getChildrenHeight()
    local maxHeight = 0
    local children = self.getResolved("children")

    for _, child in ipairs(children) do
        if child.get("visible") then
            local childY = child.get("y")
            local childHeight = child.get("height")
            local totalHeight = childY + childHeight - 1

            if totalHeight > maxHeight then
                maxHeight = totalHeight
            end
        end
    end

    return maxHeight
end

local function convertMousePosition(self, event, ...)
    local args = {...}
    if event and event:find("mouse_") then
        local button, absX, absY = ...
        local xOffset, yOffset = self.getResolved("offsetX"), self.getResolved("offsetY")
        local relX, relY = self:getRelativePosition(absX + xOffset, absY + yOffset)
        args = {button, relX, relY}
    end
    return args
end

--- @shortDescription Handles mouse scroll events
--- @param direction number The scroll direction
--- @param x number The x position of the scroll
--- @param y number The y position of the scroll
--- @return boolean handled Whether the event was handled
--- @protected
function Frame:mouse_scroll(direction, x, y)
    if(VisualElement.mouse_scroll(self, direction, x, y))then
        local args = convertMousePosition(self, "mouse_scroll", direction, x, y)
        local success, child = self:callChildrenEvent(true, "mouse_scroll", table.unpack(args))
        if success then
            return true
        end
        if self.getResolved("scrollable") then
            local height = self.getResolved("height")

            local childrenHeight = self:getChildrenHeight()
            local currentOffset = self.getResolved("offsetY")
            local maxScroll = math.max(0, childrenHeight - height)

            local newOffset = currentOffset + direction
            newOffset = math.max(0, math.min(maxScroll, newOffset))

            self.set("offsetY", newOffset)
            return true
        end
    end
    return false
end

return Frame