one class per file: framework/Web/UI/WebControls

1 files changed, 114 insertions, 0 deletions

diff --git a/framework/Web/UI/WebControls/TTemplatedWizardStep.php b/framework/Web/UI/WebControls/TTemplatedWizardStep.php
new file mode 100644
index 00000000..f928ba08
--- /dev/null
+++ b/framework/Web/UI/WebControls/TTemplatedWizardStep.php
@@ -0,0 +1,114 @@
+<?php
+/**
+ * TWizard and the relevant class definitions.
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @link http://www.pradosoft.com/
+ * @copyright Copyright &copy; 2005-2014 PradoSoft
+ * @license http://www.pradosoft.com/license/
+ * @package System.Web.UI.WebControls
+ */
+
+
+/**
+ * TTemplatedWizardStep class.
+ *
+ * TTemplatedWizardStep represents a wizard step whose content and navigation
+ * can be customized using templates. To customize the step content, specify
+ * {@link setContentTemplate ContentTemplate}. To customize navigation specific
+ * to the step, specify {@link setNavigationTemplate NavigationTemplate}. Note,
+ * if the navigation template is not specified, default navigation will be used.
+ *
+ * @author Qiang Xue <qiang.xue@gmail.com>
+ * @package System.Web.UI.WebControls
+ * @since 3.0
+ */
+class TTemplatedWizardStep extends TWizardStep implements INamingContainer
+{
+	/**
+	 * @var ITemplate the template for displaying the navigation UI of a wizard step.
+	 */
+	private $_navigationTemplate=null;
+	/**
+	 * @var ITemplate the template for displaying the content within the wizard step.
+	 */
+	private $_contentTemplate=null;
+	/**
+	 * @var TWizardNavigationContainer
+	 */
+	private $_navigationContainer=null;
+
+	/**
+	 * Creates child controls.
+	 * This method mainly instantiates the content template, if any.
+	 */
+	public function createChildControls()
+	{
+		$this->getControls()->clear();
+		if($this->_contentTemplate)
+			$this->_contentTemplate->instantiateIn($this);
+	}
+
+	/**
+	 * Ensures child controls are created.
+	 * @param mixed event parameter
+	 */
+	public function onInit($param)
+	{
+		parent::onInit($param);
+		$this->ensureChildControls();
+	}
+
+	/**
+	 * @return ITemplate the template for the content of the wizard step.
+	 */
+	public function getContentTemplate()
+	{
+		return $this->_contentTemplate;
+	}
+
+	/**
+	 * @param ITemplate the template for the content of the wizard step.
+	 */
+	public function setContentTemplate($value)
+	{
+		$this->_contentTemplate=$value;
+	}
+
+	/**
+	 * @return ITemplate the template for displaying the navigation UI of a wizard step. Defaults to null.
+	 */
+	public function getNavigationTemplate()
+	{
+		return $this->_navigationTemplate;
+	}
+
+	/**
+	 * @param ITemplate the template for displaying the navigation UI of a wizard step.
+	 */
+	public function setNavigationTemplate($value)
+	{
+		$this->_navigationTemplate=$value;
+	}
+
+	/**
+	 * @return TWizardNavigationContainer the control containing the navigation.
+	 * It could be null if no navigation template is specified.
+	 */
+	public function getNavigationContainer()
+	{
+		return $this->_navigationContainer;
+	}
+
+	/**
+	 * Instantiates the navigation template if any
+	 */
+	public function instantiateNavigationTemplate()
+	{
+		if(!$this->_navigationContainer && $this->_navigationTemplate)
+		{
+			$this->_navigationContainer=new TWizardNavigationContainer;
+			$this->_navigationTemplate->instantiateIn($this->_navigationContainer);
+		}
+	}
+}
\ No newline at end of file