Dynamic pagination cannot be accessed on user-defined layout pattern

[iGabyTM]

Hey, I need to create a paginated view that would look like this:

---------
<OOOOOOO>
<OOOOOOO>
<OOOOOOO>
---------

Where - is the filler, < and > are previous/next page buttons are O is where items would go, but I can't figure out how to that.

This is the code used in the plugin that I try to update

	@Override
    protected void onOpen(@NotNull OpenViewContext context) {
        final var config = ViewModule.getMenuConfigManager().getConfig(WarpPaginatedMenuConfig.class);
        context.setInventorySize(config.getLayout().length); // 6
        context.setInventoryTitle(config.getTitle());
        context.setLayout(config.getLayout()); // XXXXXXXXX, <OOOOOOO>, <OOOOOOO>, <OOOOOOO>, XXXXXXXXX, XXXXXXXXX
    }
    
    @Override
    protected void onRender(ViewContext context) {
        final var config = ViewModule.getMenuConfigManager().getConfig(WarpPaginatedMenuConfig.class);
        LandUser landUser = context.get("landUser");
        ViewHelper.setFillerAndDecorations(context, config);

        setSource(landUser.getWarps());

        if (landUser.getWarps().isEmpty()) {
            config.noValuesItem().forEachSlot((slot, item) -> context.slot(slot, item.getItemStack()));
        }
    }
    
    @Override
    protected void onItemRender(PaginatedViewSlotContext<LandWarp> context, ViewItem viewItem, LandWarp value) {
        final var config = ViewModule.getMenuConfigManager().getConfig(WarpPaginatedMenuConfig.class);
        Player player = context.getPlayer();

        viewItem.withItem(config.warpItem().createItem(value.createPlaceholders())).onClick(handler -> {
            if (handler.getClickOrigin().isRightClick()) {
                player.closeInventory();
                player.performCommand("land delwarp " + value.getName());
            } else if (handler.getClickOrigin().isLeftClick()) {
                player.closeInventory();
                player.performCommand("land warp " + value.getName());
            } else if (handler.getClickOrigin().getClick() == ClickType.MIDDLE) {
                value.setPublicWarp(!value.isPublicWarp());
                player.sendMessage("§aYou make this warp §f" + (value.isPublicWarp() ? "public" : "private") + "§a successfully.");

                if (value.isPublicWarp()) {
                    viewFrame.open(ChangeWarpCategoryView.class, player, ImmutableMap.of("landWarp", value));
                } else {
                    value.setCategory(LandWarpCategory.NONE);
                    player.closeInventory();
                }
            }
        });
    }

But the menu looks like this:

If the user doesn't have any warps, it looks good:

Also, I have this error when the layout doesn't have 6 rows: https://paste.helpch.at/zucofebeso.sql

[devnatan]

@iGabyTM what version of InventoryFramework are you using?

there are some remarks:

1. setSource(landUser.getWarps()) should be context.setSource(landUser.getWarps()), anything called on onRender must use context... you are probably using an outdated version as it was supposed to give an error
2. you can use User-Defined Patterns to create theses fillers.
3. it's recommended to use handler.closeUninterruptedly() instead of player.closeInventory()

your code looks right, nothing except ^^ wrong, probably a bug i'll try to reproduce

[iGabyTM]

The version I use is com.github.DevNatan:inventory-framework:v2.4.2 - I know, old - but since I don't have experience with this library and the code is fairly big, I don't have enough time to fix possible bugs.
Also, I don't really want to use layout unless I have to, e.g. I can't place the pagination items on other slots without layout or to set the items of each page in specific slots (10 - 16, 19 - 25, 28 - 34)

[devnatan]

The version I use is com.github.DevNatan:inventory-framework:v2.4.2 - I know, old - but since I don't have experience with this library and the code is fairly big, I don't have enough time to fix possible bugs. Also, I don't really want to use layout unless I have to, e.g. I can't place the pagination items on other slots without layout or to set the items of each page in specific slots (10 - 16, 19 - 25, 28 - 34)

Your need is real, it makes sense for me to allow paginated items to be applied in slots defined by themselves, i'll make a note of that. Anyway, there's no way i can give you a solution for an old version because there's a high chance that it has already been fixed in new versions. Try to use the newest version v2.5.4-rc.1, it and v2.5.4-beta fix many bugs previously reported it might be your case.

If it doesn't solve your problem, i'm here to help you.

[iGabyTM]

layout:
  - "---------"
  - "[OOOOOOO]"
  - "[OOOOOOO]"
  - "[OOOOOOO]"
  - "---------"

Looks good @devnatan but just to make sure I do things right. I couldn't set the layout and its items on onOpen due to class cast conflict between BukkitOpenViewContext and PaginatedViewContext so I moved it to onRender.

final var paginatedContext = context.paginated();
paginatedContext.setLayout(config.getLayout());
paginatedContext.setLayout('-', item -> item.setItem(config.getFiller().getItemStack()));
paginatedContext.setLayout('[', item -> item.withItem(config.previousPageItem().getItemStack()).onClick(__ -> {
    Player player = context.getPlayer();

    if (paginatedContext.isFirstPage()) {
        viewFrame.open(MainView.class, player, paginatedContext.getData());
    } else {
        paginatedContext.switchToPreviousPage();
    }
}));
paginatedContext.setLayout(']', item -> item.withItem(config.nextPageItem().getItemStack()).onClick(__ -> paginatedContext.switchToNextPage()));```

[iGabyTM]

So I've made this util class to load the layout because I will use a similar system on multiple menus that are paginated

public void setPaginationItems(
        @NotNull final PaginatedViewContext<Object> context, @NotNull final PaginatedMenuConfig config,
        @NotNull final Consumer<ViewSlotClickContext> previousPageClickHandler, @NotNull final Consumer<ViewSlotClickContext> nextPageClickHandler
) {
    context.setLayout(config.getLayout());
    context.setLayout('-', item -> item.setItem(config.getFiller().getItemStack()));
    context.setLayout('[', item -> item.withItem(config.previousPageItem(context.hasPreviousPage()).getItemStack()).onClick(previousPageClickHandler));
    context.setLayout(']', item -> item.withItem(config.nextPageItem(context.hasNextPage()).getItemStack()).onClick(nextPageClickHandler));
}

And on onRender I can the method like this:

ViewHelper.setPaginationItems(
        context.paginated(),
        config,
        handler -> {
            final var player = handler.getPlayer();

            if (handler.paginated().isFirstPage()) {
                viewFrame.open(MainView.class, player, handler.getData());
            } else {
                handler.paginated().switchToPreviousPage();
            }
        },
        handler -> handler.paginated().switchToNextPage()
);

But this https://paste.helpch.at/lakaqeqawu.rb error is thrown by context.hasNextPage() (I use this and context.hasPreviousPage to check what item I should use, nextPage/previousPage or noNextPage/noPreviousPage)
Though, I set the source on the constructor, so idk why it would be null
setSource(context -> ((LandUser) context.get("landUser")).getWarps());
Version used: com.github.DevNatan:inventory-framework:2.5.4-rc.1

[devnatan]

Hmm, ok @iGabyTM I understand why this happens, the pagination interceptor comes after the layout resolution interceptor so pagination I'll not be available on user-defined layout pattern, this is the first time this has been reported, so it's a bug, I'll change the order of the interceptors to make it possible

Looks good @devnatan but just to make sure I do things right. I couldn't set the layout and its items on onOpen due to class cast conflict between BukkitOpenViewContext and PaginatedViewContext so I moved it to onRender.

y onOpen is a pre-creation treatment of the inventory container that will be shown to the player there you prepare everything and can cancel it even before the menu is shown to the player, things related to rendering are in the class constructor and onRender.

[iGabyTM]

Any idea when a fix will be released? I kind need this soon 😅

[devnatan]

Any idea when a fix will be released? I kind need this soon 😅

Today or tomorrow, don't worry, it's literally just swapping one line for another. And you will still be able to use the fix before I release the version, using a specific build version that I will upload here

[iGabyTM]

Thank you sir 🎩