PRADO Component Framework for PHP 5
  • Home
  • About
  • Testimonials
  • Demos
  • Download
  • Documentation
  • Forum
  • Development
  • Tutorials
  • Class Docs
  • API Manual
  • Wiki

Packages

  • None
  • System
    • Caching
    • Collections
    • Data
      • ActiveRecord
        • Relations
        • Scaffold
          • InputBuilder
      • Commom
        • Sqlite
      • Common
        • Mssql
        • Mysql
        • Oracle
        • Pgsql
        • Sqlite
      • DataGateway
      • SqlMap
        • Configuration
        • Statements
    • Exceptions
    • I18N
    • IO
    • Security
    • Util
    • Web
      • Javascripts
      • Services
      • UI
        • ActiveControls
        • WebControls
    • Xml
  • Wsat
    • pages
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class TWizardNavigationEventParameter

TWizardNavigationEventParameter class.

TWizardNavigationEventParameter represents the parameter for TWizard's navigation events.

The index of the currently active step can be obtained from getCurrentStepIndex CurrentStepIndex, while the index of the candidate new step is in getNextStepIndex NextStepIndex. By modifying setNextStepIndex NextStepIndex, the new step can be changed to another one. If there is anything wrong with the navigation and it is not wanted, set setCancelNavigation CancelNavigation to true.

TComponent
Extended by TEventParameter
Extended by TWizardNavigationEventParameter
Package: System\Web\UI\WebControls
Copyright: Copyright © 2005-2014 PradoSoft
License: http://www.pradosoft.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 3.0
Located at Web/UI/WebControls/TWizard.php
Methods summary
public
# __construct( integer $currentStep )

Constructor.

Constructor.

Parameters

$currentStep
integer
current step index

Overrides

TComponent::__construct()
public integer
# getCurrentStepIndex( )

Returns

integer
the zero-based index of the currently active step.
public integer
# getNextStepIndex( )

Returns

integer
the zero-based index of the next step. Default to getCurrentStepIndex CurrentStepIndex.
public
# setNextStepIndex( integer $index )

Parameters

$index
integer
the zero-based index of the next step.
public boolean
# getCancelNavigation( )

Returns

boolean
whether navigation to the next step should be canceled. Default to false.
public
# setCancelNavigation( boolean $value )

Parameters

$value
boolean
whether navigation to the next step should be canceled.
Methods inherited from TComponent
__call(), __destruct(), __get(), __isset(), __set(), __sleep(), __unset(), __wakeup(), addParsedObject(), asa(), attachBehavior(), attachBehaviors(), attachClassBehavior(), attachEventHandler(), canGetProperty(), canSetProperty(), clearBehaviors(), createdOnTemplate(), detachBehavior(), detachBehaviors(), detachClassBehavior(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), evaluateStatements(), fxAttachClassBehavior(), fxDetachClassBehavior(), getAutoGlobalListen(), getBehaviorsEnabled(), getClassHierarchy(), getEventHandlers(), getListeningToGlobalEvents(), getSubProperty(), hasEvent(), hasEventHandler(), hasProperty(), isa(), listen(), raiseEvent(), setSubProperty(), unlisten()
Constants inherited from TComponent
GLOBAL_RAISE_EVENT_LISTENER
Terms of Service | Contact Us
PRADO v3.2.4 API Manual API documentation generated by ApiGen 2.8.0
Copyright © 2006-2014 by the PRADO Group.
Powered by PRADO