mirror of
https://github.com/Relintai/pandemonium_engine.git
synced 2024-12-28 06:37:11 +01:00
102 lines
4.3 KiB
XML
102 lines
4.3 KiB
XML
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<class name="HTMLPaginator" inherits="Reference" version="4.4">
|
|
<brief_description>
|
|
A class that can be used to generate html pagination.
|
|
</brief_description>
|
|
<description>
|
|
A class that can be used to generate html pagination.
|
|
Pagination means page selection links on HTML pages when more than one page is available.
|
|
The [code]get_current()[/code] helper can be used to get the generated HTML for the current page. [code]start()[/code] and [code]next()[/code] helpers are also provided as an enumerator like interface. They are convenient if pages can be built and cached during startup for example.
|
|
A Renderer [HTMLPaginator] can be set to an another [HTMLPaginator] class. If a renderer [HTMLPaginator] is set, then it's render methods will be used to render the links instead of the built in of the current class. This enables customization of styles for core classes, in a relatively simple and in a less error prone way.
|
|
</description>
|
|
<tutorials>
|
|
</tutorials>
|
|
<methods>
|
|
<method name="_render_indexed" qualifiers="virtual">
|
|
<return type="void" />
|
|
<argument index="0" name="target" type="HTMLPaginator" />
|
|
<argument index="1" name="page_index" type="int" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="_render_links" qualifiers="virtual">
|
|
<return type="void" />
|
|
<argument index="0" name="target" type="HTMLPaginator" />
|
|
<argument index="1" name="page_index" type="int" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="get_current">
|
|
<return type="String" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="get_pagination_for_indx">
|
|
<return type="String" />
|
|
<argument index="0" name="page_index" type="int" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="get_pagination_for_num">
|
|
<return type="String" />
|
|
<argument index="0" name="page_num" type="int" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="next">
|
|
<return type="String" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="render_indexed">
|
|
<return type="String" />
|
|
<argument index="0" name="target" type="HTMLPaginator" />
|
|
<argument index="1" name="page_index" type="int" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="render_links">
|
|
<return type="String" />
|
|
<argument index="0" name="target" type="HTMLPaginator" />
|
|
<argument index="1" name="page_index" type="int" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
<method name="start">
|
|
<return type="void" />
|
|
<description>
|
|
</description>
|
|
</method>
|
|
</methods>
|
|
<members>
|
|
<member name="base_url" type="String" setter="set_base_url" getter="get_base_url" default="""">
|
|
</member>
|
|
<member name="class_disabled_li" type="String" setter="set_class_disabled_li" getter="get_class_disabled_li" default=""disabled"">
|
|
</member>
|
|
<member name="class_enabled_li" type="String" setter="set_class_enabled_li" getter="get_class_enabled_li" default="""">
|
|
</member>
|
|
<member name="class_main_ul" type="String" setter="set_class_main_ul" getter="get_class_main_ul" default=""pagination"">
|
|
</member>
|
|
<member name="hide_if_one_page" type="bool" setter="set_hide_if_one_page" getter="get_hide_if_one_page" default="false">
|
|
</member>
|
|
<member name="item_count" type="int" setter="set_item_count" getter="get_item_count" default="0">
|
|
</member>
|
|
<member name="links" type="PoolStringArray" setter="set_links" getter="get_links" default="PoolStringArray( )">
|
|
</member>
|
|
<member name="max_visible_links" type="int" setter="set_max_visible_links" getter="get_max_visible_links" default="10">
|
|
</member>
|
|
<member name="page_count" type="int" setter="set_page_count" getter="get_page_count" default="0">
|
|
</member>
|
|
<member name="renderer" type="HTMLPaginator" setter="set_renderer" getter="get_renderer">
|
|
</member>
|
|
<member name="text_next_link" type="String" setter="set_text_next_link" getter="get_text_next_link" default=""next"">
|
|
</member>
|
|
<member name="text_prev_link" type="String" setter="set_text_prev_link" getter="get_text_prev_link" default=""previous"">
|
|
</member>
|
|
<member name="use_links_array" type="bool" setter="set_use_links_array" getter="get_use_links_array" default="false">
|
|
</member>
|
|
</members>
|
|
<constants>
|
|
</constants>
|
|
</class>
|