com.wewebu.ow.server.dmsdialogs.views
Interface OwPageableView

All Superinterfaces:
OwBaseView
All Known Implementing Classes:
OwObjectEditVersionsView, OwObjectListView, OwObjectListViewCombined, OwObjectListViewCombined.OwObjectListViewRowCombined, OwObjectListViewEXTJSGrid, OwObjectListViewFilterEXTJSGrid, OwObjectListViewFilterRow, OwObjectListViewPluginCache, OwObjectListViewRow, OwObjectListViewThumbnails

public interface OwPageableView
extends OwBaseView

Base interface for the views that intends to use different paging components.

Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.

For licensing information read the license.txt file or
go to: http://wiki.alfresco.com

Since:
2.5.2.0

Field Summary
 
Fields inherited from interface com.wewebu.ow.server.ui.OwBaseView
EMPTY_STRING
 
Method Summary
 boolean canPageNext()
          Check if there is a next page
 boolean canPagePrev()
          Check if there is a previous page
 OwPageSelectorComponent createPageSelector()
          Create the paging component, according with the configuration setting.
 OwAppContext getContext()
          get the context reference
 int getCount()
          Get number of items.
 int getCurrentPage()
          Get the current page
 String getPageAbsolutEventURL(String aditionalParameters_p)
          Get URL for a given page number
 int getPageCount()
          retrieve number of available pages
 String getPageNextEventURL()
          Get the next page URL.
 String getPagePrevEventURL()
          Get the previous page URL.
 boolean hasPaging()
          Check if the current view must show the paging component.
 void onPageAbsolut(javax.servlet.http.HttpServletRequest request_p)
          display absolute page of objects
 void onPageNext(javax.servlet.http.HttpServletRequest request_p)
          display next page of objects
 void onPagePrev(javax.servlet.http.HttpServletRequest request_p)
          display previous page of objects
 
Methods inherited from interface com.wewebu.ow.server.ui.OwBaseView
getBreadcrumbPart, getTitle, isNamedRegion, isRegion, render, renderNamedRegion, renderRegion
 

Method Detail

onPageAbsolut

void onPageAbsolut(javax.servlet.http.HttpServletRequest request_p)
                   throws Exception
display absolute page of objects

Throws:
Exception

onPageNext

void onPageNext(javax.servlet.http.HttpServletRequest request_p)
                throws Exception
display next page of objects

Throws:
Exception

onPagePrev

void onPagePrev(javax.servlet.http.HttpServletRequest request_p)
                throws Exception
display previous page of objects

Throws:
Exception

getPageCount

int getPageCount()
                 throws Exception
retrieve number of available pages

Returns:
int - number of pages for paging in multiples of getPageSize()
Throws:
Exception

getCurrentPage

int getCurrentPage()
                   throws Exception
Get the current page

Returns:
current page
Throws:
Exception

getContext

OwAppContext getContext()
get the context reference

Returns:
OwAppContext Application context

canPagePrev

boolean canPagePrev()
Check if there is a previous page

Returns:
boolean true = there is a previous page, pagePrev is possible

canPageNext

boolean canPageNext()
                    throws Exception
Check if there is a next page

Returns:
boolean true = there is a next page, pageNext is possible
Throws:
Exception

getCount

int getCount()
Get number of items.

Returns:
int - the number of items

getPagePrevEventURL

String getPagePrevEventURL()
Get the previous page URL.

Returns:
the page previous URL

getPageNextEventURL

String getPageNextEventURL()
Get the next page URL.

Returns:
the next page URL

hasPaging

boolean hasPaging()
Check if the current view must show the paging component.

Returns:
true if the current view must show the paging component.

getPageAbsolutEventURL

String getPageAbsolutEventURL(String aditionalParameters_p)
Get URL for a given page number

Parameters:
aditionalParameters_p - - query parameters in a http link
Returns:
the URL

createPageSelector

OwPageSelectorComponent createPageSelector()
                                           throws Exception
Create the paging component, according with the configuration setting. In case that no paging element is set, the direct input page selector component is used.

Returns:
an instance of OwPageSelectorComponent.
Throws:
Exception


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.