lumis.doui.control.pagination
Class PaginationControl

Package class diagram package PaginationControl
java.lang.Object
  extended by lumis.doui.control.Control
      extended by lumis.doui.control.DataControl
          extended by lumis.doui.control.DataBoundControl<TabularSource>
              extended by lumis.doui.control.pagination.PaginationControl
All Implemented Interfaces:
Observer, VariableResolver, IClientSideReadableControl, IControl, IDataBoundControl, IDataControl, IRenderer

public class PaginationControl
extends DataBoundControl<TabularSource>
implements IClientSideReadableControl

Renders the current selected page and possible pages that the use can navigate to.

Example use:

<control:lum_pagination id="pagination"/> xml data available for xsl rendering: <control id="pagination" sourceId="default" type="lum_pagination"> <strings> <string id="STR_NEXT_PAGE">Next page</string> <string id="STR_PAGES">Pages</string> <string id="STR_PREVIOUS_BLOCK">Previous block of pages</string> <string id="STR_FIRST_PAGE">First page</string> <string id="STR_LAST_PAGE">Last page</string> <string id="STR_NEXT_BLOCK">Next block of pages</string> <string id="STR_PREVIOUS_PAGE">Previous page</string> </strings> <data> <numPages>3</numPages> <previousPage href="javascript:function f1(){ var y = null; var x = document.forms['Form_8A488A03117086C7011170BF8F8C040D'].elements['pagination'];if(x.type == undefined) y = x[0]; else y = x; y.value='1';LumisPortal.onSubmitForm('Form_8A488A03117086C7011170BF8F8C040D','8A488A03117086C7011170BF8F8C040D');}f1();" hrefQSParameter="main.jsp?lumPageId=8A488A03117086C7011170BF8F50040C&pagination=1">1</previousPage> <page href="javascript:function f1(){ var y = null; var x = document.forms['Form_8A488A03117086C7011170BF8F8C040D'].elements['pagination'];if(x.type == undefined) y = x[0]; else y = x; y.value='1';LumisPortal.onSubmitForm('Form_8A488A03117086C7011170BF8F8C040D','8A488A03117086C7011170BF8F8C040D');}f1();" hrefQSParameter="main.jsp?lumPageId=8A488A03117086C7011170BF8F50040C&pagination=1">1</page> <page currentPage="true" href="javascript:function f1(){ var y = null; var x = document.forms['Form_8A488A03117086C7011170BF8F8C040D'].elements['pagination'];if(x.type == undefined) y = x[0]; else y = x; y.value='4';LumisPortal.onSubmitForm('Form_8A488A03117086C7011170BF8F8C040D','8A488A03117086C7011170BF8F8C040D');}f1();" hrefQSParameter="main.jsp?lumPageId=8A488A03117086C7011170BF8F50040C&pagination=4">2</page> <page href="javascript:function f1(){ var y = null; var x = document.forms['Form_8A488A03117086C7011170BF8F8C040D'].elements['pagination'];if(x.type == undefined) y = x[0]; else y = x; y.value='7';LumisPortal.onSubmitForm('Form_8A488A03117086C7011170BF8F8C040D','8A488A03117086C7011170BF8F8C040D');}f1();" hrefQSParameter="main.jsp?lumPageId=8A488A03117086C7011170BF8F50040C&pagination=7">3</page> <nextPage href="javascript:function f1(){ var y = null; var x = document.forms['Form_8A488A03117086C7011170BF8F8C040D'].elements['pagination'];if(x.type == undefined) y = x[0]; else y = x; y.value='7';LumisPortal.onSubmitForm('Form_8A488A03117086C7011170BF8F8C040D','8A488A03117086C7011170BF8F8C040D');}f1();" hrefQSParameter="main.jsp?lumPageId=8A488A03117086C7011170BF8F50040C&pagination=7">3</nextPage> </data> </control>

Since:
4.0.0

Field Summary
 
Fields inherited from class lumis.doui.control.DataControl
FORCE_CASE_LOWER, FORCE_CASE_NONE, FORCE_CASE_UPPER, forceCase, requestParameterName, UNKNOWN_DATA_TYPE, value, valuePreviouslySet
 
Fields inherited from class lumis.doui.control.Control
childControls, controlContainer, controlDefinitionNode, controlResource, douiContext, hasValidatorSubControls, isValid, locale, ON_EVENT_CLOSE_WINDOW, ON_EVENT_LINK, ON_EVENT_POPUP_LINK_OR_RUNTIME_INTERFACE, ON_EVENT_POPUP_RUNTIME_INTERFACE, ON_EVENT_PROCESS_ACTION, ON_EVENT_RENDER_ACTION, ON_EVENT_SCRIPT, onEventScripts, PARAMETER_TYPE_FIRST_SELECTED, PARAMETER_TYPE_GET_VALUE, parentControl, resources, type, VALIDATION_SELECTED_MANY, VALIDATION_SELECTED_ONE
 
Constructor Summary
PaginationControl()
           
 
Method Summary
protected  boolean fixedIdentifierRequired()
           
 IResource getControlResource()
           
protected  Map<String,String> getStringsToLocalize()
           
 void loadFromRequest()
           
 void setRenderData()
           
 void setValue(Object value)
          Sets the value for this control.
protected  void setValueFromSource()
           
 
Methods inherited from class lumis.doui.control.DataBoundControl
autoAddDateTimeValueValidator, autoAddDoubleValueValidator, autoAddFileSizeValidator, autoAddIntegerValueValidator, autoAddLengthValidator, autoAddLongValueValidator, autoAddRequiredValueValidator, autoAddValidators, buildSubControls, createConverter, createDataType, getDataId, getFieldName, getProcessActionHandlerParameterName, getReload, getRuntimeDefaultSource, getSource, getSourceById, getUnboundedConverter, init, setDefaultValue, setRawValue, setReload, setSourceParameter, setSourceParameters, setsSourceParameters, setValid, setValueFromSource, update
 
Methods inherited from class lumis.doui.control.DataControl
convertValueToControlValue, getConverter, getDataType, getDefaultValue, getRequestParameterName, getValue, getValue, getValueClass, isTrim, loadSubControlFromRequest, loadSubControlsFromRequest, setProcessActionHandlerParameter, setProcessActionHandlerParameters, setTrim, valueIsArray
 
Methods inherited from class lumis.doui.control.Control
appendSubControl, appendSubControls, applyOnEventScripts, convertToStandardValue, createContainer, disconnect, generateControlId, getAdditionalParameters, getAncestor, getChildControls, getClientEventHandlerScript, getId, getLocale, getParentControl, getPrepareForReadScript, getRenderData, getResources, getScriptActionValidation, getScriptGetValues, getScriptGetValuesFunctionImplementation, getScriptGetValuesFunctionName, getScriptGetValuesRegistration, getSourceContext, getType, getValidationScript, isValid, localize, localizeStrings, processCustomTags, registerOnEventScript, removeChild, removeChildren, resolveVariable, setRuntimeAttributes
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface lumis.doui.control.IClientSideReadableControl
getScriptGetValues, getScriptGetValuesRegistration
 
Methods inherited from interface lumis.doui.control.IDataControl
getConverter, getValue, getValue, setProcessActionHandlerParameters
 
Methods inherited from interface lumis.doui.control.IControl
createContainer, disconnect, getChildControls, getId, getParentControl, getPrepareForReadScript, getRenderData, getResources, getType, isValid, registerOnEventScript, removeChild, removeChildren, setRuntimeAttributes
 
Methods inherited from interface lumis.doui.render.IRenderer
getResources, getSourceContext
 

Constructor Detail

PaginationControl

public PaginationControl()
Method Detail

loadFromRequest

public void loadFromRequest()
                     throws PortalException
Specified by:
loadFromRequest in interface IDataControl
Overrides:
loadFromRequest in class DataBoundControl<TabularSource>
Throws:
PortalException

setValue

public void setValue(Object value)
              throws PortalException
Description copied from class: DataControl
Sets the value for this control. The value is converted to this control's value class using DataControl.convertValueToControlValue(Object, Locale, String). Then the value is set using DataControl.setRawValue(Object).

Specified by:
setValue in interface IDataControl
Overrides:
setValue in class DataControl
Parameters:
value - the value to set. It is automatically converted as necessary.
Throws:
PortalException

setValueFromSource

protected void setValueFromSource()
                           throws PortalException
Overrides:
setValueFromSource in class DataBoundControl<TabularSource>
Throws:
PortalException

setRenderData

public void setRenderData()
                   throws PortalException
Specified by:
setRenderData in interface IControl
Overrides:
setRenderData in class DataBoundControl<TabularSource>
Throws:
PortalException

getStringsToLocalize

protected Map<String,String> getStringsToLocalize()
Overrides:
getStringsToLocalize in class Control

getControlResource

public IResource getControlResource()
                             throws PortalException
Specified by:
getControlResource in interface IControl
Overrides:
getControlResource in class Control
Throws:
PortalException

fixedIdentifierRequired

protected boolean fixedIdentifierRequired()
Overrides:
fixedIdentifierRequired in class Control


Lumisportal  4.1.0.071221 - Copyright © 2001-2007, Lumis. All Rights Reserved.