Adding a printable view - Revision history

bahtiar: /* Create New Node */ highlighting

2007-10-17T22:25:37Z

Create New Node: highlighting

← Older revision		Revision as of 22:25, 17 October 2007
Line 82:		Line 82:
	In the constructor add the code to instantiate the attribute.		In the constructor add the code to instantiate the attribute.

			<syntaxhighlight lang="php">
	$this->add(new atkMyNewAttribute("newattribute", "id", AF_HIDE_LIST\|AF_NO_LABEL), "tab name");		$this->add(new atkMyNewAttribute("newattribute", "id", AF_HIDE_LIST\|AF_NO_LABEL), "tab name");
			</syntaxhighlight>

	Next we'll develop a method that pops up the window using the dispatch handler. Note, some of the parameters to the NewWindow javascript code are altered to display the window. This code is pretty much boilerplate, and based on the atkPopup method in atk/ui.		Next we'll develop a method that pops up the window using the dispatch handler. Note, some of the parameters to the NewWindow javascript code are altered to display the window. This code is pretty much boilerplate, and based on the atkPopup method in atk/ui.

			<syntaxhighlight lang="php">
	function dispatchPopup($target,$params,$winName,$width,$height,$scroll='no',$resize='no')		function dispatchPopup($target,$params,$winName,$width,$height,$scroll='no',$resize='no')
	{		{
Line 93:		Line 95:
	return $popupurl;		return $popupurl;
	}		}
			</syntaxhighlight>

	To add a button above the display of the new attribute, we overload the display handler for that attribute within the node.		To add a button above the display of the new attribute, we overload the display handler for that attribute within the node.

			<syntaxhighlight lang="php">
	function newattribute_display($record)		function newattribute_display($record)
	{		{
Line 113:		Line 116:
	return $output;		return $output;
	}		}
			</syntaxhighlight>

	Finally, add the action handler.		Finally, add the action handler.

			<syntaxhighlight lang="php">
	function action_newattribute(&$handler){		function action_newattribute(&$handler)
			{
	$ui = &$this->getUi();		$ui = &$this->getUi();
	$newattribute = &$this->getAttribute("newattribute");		$newattribute = &$this->getAttribute("newattribute");
Line 147:		Line 150:

	}// end function		}// end function
			</syntaxhighlight>

	== Create Templates ==		== Create Templates ==

bahtiar: /* Create Derived Attribute */ added highlighting

2007-10-17T22:24:54Z

Create Derived Attribute: added highlighting

← Older revision		Revision as of 22:24, 17 October 2007
Line 28:		Line 28:
	Starting with the atkDummyAttribute, modify the display method. In this case, I've modified display to execute a query and display the contents.		Starting with the atkDummyAttribute, modify the display method. In this case, I've modified display to execute a query and display the contents.

			<syntaxhighlight lang="php">
	/**		/**
	* Display a record		* Display a record
Line 71:		Line 72:
	return $output;		return $output;
	}		}
			</syntaxhighlight>

	== Create New Node ==		== Create New Node ==

Ihcfan at 09:07, 15 October 2007

2007-10-15T09:07:06Z

← Older revision		Revision as of 09:07, 15 October 2007
Line 152:		Line 152:
	The template mentioned above (mytemplate.tpl) is created to strip the typical 'achievo' look from the print window. In it's most basic form it looks like:		The template mentioned above (mytemplate.tpl) is created to strip the typical 'achievo' look from the print window. In it's most basic form it looks like:

	~~[code]~~		<nowiki>
	<div style="padding: 4px; bgcolor=#ffffff;">		<div style="padding: 4px; bgcolor=#ffffff;">
	{$content}		{$content}
	</div>		</div>
	<br>		<br>
	[/~~code]~~		</nowiki>

	The style sheet is used to alter the format of the table created in the custom attribute's display() method.		The style sheet is used to alter the format of the table created in the custom attribute's display() method.

Ihcfan at 09:03, 15 October 2007

2007-10-15T09:03:47Z

← Older revision		Revision as of 09:03, 15 October 2007
Line 152:		Line 152:
	The template mentioned above (mytemplate.tpl) is created to strip the typical 'achievo' look from the print window. In it's most basic form it looks like:		The template mentioned above (mytemplate.tpl) is created to strip the typical 'achievo' look from the print window. In it's most basic form it looks like:

	[~~quote~~]		[code]
	<div style="padding: 4px; bgcolor=#ffffff;">		<div style="padding: 4px; bgcolor=#ffffff;">
	{$content}		{$content}
	</div>		</div>
	<br>		<br>
	[/~~quote~~]		[/code]

	The style sheet is used to alter the format of the table created in the custom attribute's display() method.		The style sheet is used to alter the format of the table created in the custom attribute's display() method.

Ihcfan at 09:03, 15 October 2007

2007-10-15T09:03:18Z

← Older revision		Revision as of 09:03, 15 October 2007
Line 152:		Line 152:
	The template mentioned above (mytemplate.tpl) is created to strip the typical 'achievo' look from the print window. In it's most basic form it looks like:		The template mentioned above (mytemplate.tpl) is created to strip the typical 'achievo' look from the print window. In it's most basic form it looks like:

			[quote]
	<div style="padding: 4px; bgcolor=#ffffff;">		<div style="padding: 4px; bgcolor=#ffffff;">
	{$content}		{$content}
	</div>		</div>
	<br>		<br>
			[/quote]

	The style sheet is used to alter the format of the table created in the custom attribute's display() method.		The style sheet is used to alter the format of the table created in the custom attribute's display() method.

Ihcfan at 09:00, 15 October 2007

2007-10-15T09:00:17Z

@@ Line 111: / Line 111: @@
        return $output;
+     }
@@ Line 116: / Line 150: @@
-Blah
+The template mentioned above (mytemplate.tpl) is created to strip the typical 'achievo' look from the print window.  In it's most basic form it looks like:
-== Try it Out ==
+== Helpful Hints ==
-Blah
+When altering the template, delete the compiled crud from the atktmp directory.

Ihcfan at 08:41, 15 October 2007

2007-10-15T08:41:59Z

← Older revision		Revision as of 08:41, 15 October 2007
Line 111:		Line 111:
	return $output;		return $output;
	}		}




	~~== Add Button ==~~


	~~Blah~~

Ihcfan at 08:21, 15 October 2007

2007-10-15T08:21:33Z

← Older revision		Revision as of 08:21, 15 October 2007
Line 72:		Line 72:
	}		}

			== Create New Node ==


			The new node will use the derived attribute just created, and will place controls in the environment to actually pop up the window.



			In the constructor add the code to instantiate the attribute.

	== ~~Create New Node~~ ==		$this->add(new atkMyNewAttribute("newattribute", "id", AF_HIDE_LIST\|AF_NO_LABEL), "tab name");


			Next we'll develop a method that pops up the window using the dispatch handler. Note, some of the parameters to the NewWindow javascript code are altered to display the window. This code is pretty much boilerplate, and based on the atkPopup method in atk/ui.

			function dispatchPopup($target,$params,$winName,$width,$height,$scroll='no',$resize='no')
			{
			$url = session_url("dispatch.php?".$params, SESSION_NESTED);
			$popupurl ="javascript:NewWindow('".$url."','".$winName."',".$height.",".$width.",'".$scroll."','".$resize."','no','yes')";
			return $popupurl;
			}


			To add a button above the display of the new attribute, we overload the display handler for that attribute within the node.

			function newattribute_display($record)
			{
			$page = &$this->getPage();
			$page->register_script(atkconfig("atkroot")."atk/javascript/newwindow.js");

			$newattribute = &$this->getAttribute("newattribute");
			$sParams = str_ireplace("atkaction=view", "atkaction=newattribute", $_SERVER['QUERY_STRING']);

			// this constructs the button HTML.
			$content = $this->dispatchPopup('dispatch.php',$sParams,'printWindow',500,800, 'yes', 'yes');
			$temp = '<input type="button" value="PRINT" onClick="' . $content . '" />';

			// return the output.
			$output = $temp.$newattribute->display($record);
			return $output;
			}


	~~Blah~~

Ihcfan at 08:09, 15 October 2007

2007-10-15T08:09:55Z

← Older revision		Revision as of 08:09, 15 October 2007
Line 24:		Line 24:


	~~Blah~~		The goal of the derived attribute is to handle rendering the record in both a popup window and on the edit/view pages. In this howto, only view mode is handled, since the primary goal is the display of a window suitable for printing.

			Starting with the atkDummyAttribute, modify the display method. In this case, I've modified display to execute a query and display the contents.

			/**
			* Display a record
			* Here it will only returns the text.
			* @param $record Array with fields
			* @return Parsed string
			*/
			function display($record)
			{
			$db = &atkGetDb();

			$query = &$db->createQuery();
			$query->addTable("stuff");
			$query->addJoin("item", "", "item.id = stuff.item_id", false);
			$query->addJoin("notes", "", "notes.id = item.notes_id", false);
			$query->addField("item.item");
			$query->addField("item.name");
			$query->addField("notes.note");
			$query->addField("stuff.name as sname");
			$query->addCondition("stuff.person_id = ".$record["id"]);

			$stuff = $db->getrows($query->buildSelect());
			$tbl = &atknew("atk.utils.atktablerenderer");

			$data = array();
			// Develop a table however you'd like it to display

			// Use cascading style sheets to alter the appearance.
			$tbl->setRowClass(1, "superbold");
			// ....
			// Create data
			for ($i=0, $_i=count($stuff); $i<$_i; $i++)
			{
			$row = array();
			$row[]="";
			$row[]=$stuff[$i]["..."];
			$row[]=$stuff[$i]["..."];
			$data[] = $row;
			}

			// render table.
			$output = $tbl->render($data, 0, "navpers");
			return $output;
			}

Ihcfan at 07:44, 15 October 2007

2007-10-15T07:44:48Z

← Older revision		Revision as of 07:44, 15 October 2007
Line 5:		Line 5:

	In this howto you will create a popup window with altered format stripping away elements that interfere with cleanly rendering the information on a printer or other alternative output device.		In this howto you will create a popup window with altered format stripping away elements that interfere with cleanly rendering the information on a printer or other alternative output device.


	== Basic Process ==		== Basic Process ==


	I am sure there are many ways of achieving this, however this presents a method that I used, that worked for my application. There are four main development tasks to complete:		I am sure there are many ways of achieving this, however this presents a method that I used, that worked for my application. There are four main development tasks to complete:

	1. Develop a derived attribute capable of rendering the appropriate view.		1. Develop a derived attribute capable of rendering the appropriate view.

	2. Develop a node which uses the derived attribute.		2. Develop a node which uses the derived attribute.

	3. Add a button to the node which pops up the the window.		3. Add a button to the node which pops up the the window.

	4. Develop the appropriate template and style sheets if necessary.		4. Develop the appropriate template and style sheets if necessary.


	== Create Derived Attribute ==		== Create Derived Attribute ==


	Blah		Blah


	== Create New Node ==		== Create New Node ==


	Blah		Blah


	== Add Button ==		== Add Button ==


	Blah		Blah


	== Create Templates ==		== Create Templates ==


	Blah		Blah


	== Try it Out ==		== Try it Out ==


	Blah		Blah