Updating page editor hooks for v4.9.3

From Sohowiki
(Difference between revisions)
Jump to: navigation, search
(pe-properties_dialog_layer)
(Final note)
 
(21 intermediate revisions by one user not shown)
Line 1: Line 1:
==Overview==
+
==How To Update==
 
+
Within your object javascript simply add the following to the end, that is, after you have placed your object into the cell.
===Introduction===
+
This article should explain the changes made to the page editor hook attachments for version 4.9.3.  Standard hooks such as pe_ff-place_object_js and pe_ff-properties_dialog_layer will no longer be used as the page editor files (page_editor.php and page_editor-ff.php) have been combined.  page_editor.php is about half the size and quite a bit more efficient.  Functionality such as moving single objects to and from cells, stretching cells which display all content of the cell, and updated visual effects have been added.
+
 
+
Just like the [[Plugging-in_to_the_Page_Editor|Plugging-in to the Page Editor]] article, the Scrolling Newsbox plugin will be used to show comparisons between the old way and the new way.
+
 
+
==Install manifest==
+
 
+
The only difference here is the removed Firefox hook_attach.
+
 
<pre>
 
<pre>
#Firefox
+
if ( window.checkPageAreas ){
hook_attach("scroll_js-ff.php", "pe_ff-place_object_js");
+
  checkPageAreas('start');
hook_attach("scroll_props-ff.php", "pe_ff-properties_dialog_layer");
+
}
 
</pre>
 
</pre>
The hooks "pe_ff-place_object_js" and "pe_ff-properties_dialog_layer" are no longer in the code and will not have any effect.
 
<pre>
 
<?
 
# PLUGIN INFO
 
$plugin_folder = "SCROLLNEWS";
 
$plugin_title = "Scrolling Newbox";
 
$plugin_version = "2.1";
 
$plugin_description = "Cool scrolling newsbox.";
 
$plugin_author = "Joe Lain";
 
$plugin_homepage = "http://soholaunch.com";
 
$plugin_icon = "scrolling_icon.gif";
 
$plugin_options_link = "newsbox_setup.php";
 
  
# PLUGIN DATABASE TABLES
+
Our scrolling newsbox OkScrollData() function now looks like this.
# If this plugin creates any database tables
+
# list them here so that Pro Edition knows to drop them
+
# during the un-installation process
+
$drop_tables[] = "scrolling_newsbox_cat";
+
$drop_tables[] = "scrolling_newsbox_content";
+
  
# SPECIAL HOOK: Main menu button
 
# Use this if you want to place a button for your plugin on Pro Edition's Main Menu
 
# ...which links to some kind of config/managment module for your plugin.
 
# If your plugin doesn't involve a config/management module
 
# (as in, it runs exactly as installed with no further input needed from the user)
 
# then a main menu button probably isn't neccessary.
 
$data = array();
 
$data['enabled_button_image'] = "scrolling_icon.gif";
 
$data['disabled_button_image'] = "scrolling_icon.gif";
 
$data['enabled_button_link'] = "newsbox_setup.php";
 
$data['button_caption_text'] = "Scrolling Newsbox";
 
$data['multiuser_access_code'] = ";MOD_SCROLLING_NEWSBOX;";
 
hook_special("main_menu_button", $data);
 
 
# SPECIAL HOOK: Header nav buttons
 
$data = array();
 
$data['button1']['button_text'] = "Scrolling Newsbox Menu"; // This string will be passed through lang() for translation
 
$data['button1']['button_onclick'] = base64_encode("parent.body.location.href='../plugins/SCROLLNEWS/newsbox_setup';"); // Do not use single quotes in this string
 
 
hook_special("header_nav_buttons", $data);
 
 
# Page Editor
 
$data = array();
 
$data['draggable_object_image'] = "eng-icon_scroll.gif";
 
$data['draggable_object_id'] = "scroll_obj";
 
$data['properties_dialog_id'] = "scrollProps";
 
$data['mod_folder'] = $plugin_folder;
 
$data['properties_dialog_file'] = $plugin_folder.DIRECTORY_SEPARATOR."scroll_props.php";
 
$data['place_object_js_function'] = $plugin_folder.DIRECTORY_SEPARATOR."scroll_js.php";
 
hook_special("page_editor_object", $data);
 
 
# Page Editor javascript and properties layer
 
hook_attach("scroll_js.php", "pe-place_object_js");
 
hook_attach("scroll_props.php", "pe-properties_dialog_layer");
 
 
# Misc
 
hook_attach("scroll_rtb.php", "rtb_contentloop");
 
hook_attach("scroll_write.php", "pe-confile_object_data");
 
?>
 
</pre>
 
 
==The Changed Files==
 
====Overview====
 
Here I will explain the differences in the page editor properties layer and javascript.  This applies to the following portion of our install manifest.
 
<pre>
 
# Page Editor javascript and properties layer
 
hook_attach("scroll_js.php", "pe-place_object_js");
 
hook_attach("scroll_props.php", "pe-properties_dialog_layer");
 
</pre>
 
 
====pe-properties_dialog_layer====
 
This file can really remain the same, it will function properly as is.  But, if you would like to update the layer styles and make it consistent with the other layers the following code will help you do so.
 
 
You can reference the code for the old scrolling newsbox properties layer [[Plugging-in_to_the_Page_Editor#The_code|here]].
 
<pre>
 
<DIV ID="scrollProps" class="prop_layer">
 
 
  <div class="prop_head">Scrolling Newsbox Selection</div>
 
 
<table cellpadding="0" cellspacing="0" width="100%" class="prop_table">
 
<tr>
 
<td align=center valign=top class=ctable>
 
 
Which Scrolling Newsbox should appear here?
 
 
<SELECT id="scrollname" NAME="scrollname" style='font-face: Arial; font-size: 8pt; width: 250px;'>
 
<option value="NULL" STYLE='color:#999999;'>Newsboxes:</option>
 
 
<?
 
 
  $result = mysql_query("SELECT * FROM scrolling_newsbox_cat");
 
 
      while ($row=mysql_fetch_array($result)){
 
if ($tmp == "#EFEFEF") { $tmp = "WHITE"; } else { $tmp = "#EFEFEF"; }
 
echo "<option value=\"".$row['prikey']."\" STYLE='background: $tmp;'>".$row['CAT_NAME']."</option>\n";
 
}
 
 
?>
 
 
</SELECT>
 
 
</td>
 
<td align=center valign=middle>
 
 
<input type=button class=mikebut onMouseOver="this.className='mikebutOn';" onMouseOut="this.className='mikebut';" value=" OK " onClick="OkScrollData();show_hide_layer('objectbar_mods','','show','scrollProps','','hide');">
 
&nbsp;&nbsp;<input type=button class=mikebut onMouseOver="this.className='mikebutOn';" onMouseOut="this.className='mikebut';" value=" Cancel " onClick="show_hide_layer('objectbar_mods','','show','scrollProps','','hide');">
 
 
</td>
 
 
</tr>
 
</table>
 
 
</DIV>
 
</pre>
 
'''Changed lines-'''
 
 
from
 
<pre>
 
<DIV ID="scrollProps" style="position:absolute; left:0px; top:0px; width:100%; height:115; z-index:4; overflow: none; background-color: oldlace; visibility: hidden" onMouseOver="HighDropZone();">
 
 
    <table border=1 cellpadding=0 cellspacing=0 width=100% height=100% style='border: 1px inset black;'>
 
          <tr>
 
              <td align=center valign=middle>
 
 
                    <table border=0 cellpadding=2 cellspacing=0 width=100%>
 
</pre>
 
to
 
<pre>
 
<DIV ID="scrollProps" class="prop_layer">
 
 
  <div class="prop_head">Scrolling Newsbox Selection</div>
 
 
<table cellpadding="0" cellspacing="0" width="100%" class="prop_table">
 
</pre>
 
Please notice use of the classes prop_layer, prop_head, and prop_table.  Also, we are getting rid of one of the tables so don't forget to kill the closing tags also.
 
 
As I mentioned before, these changes are not mandatory but will make your properties layer fit in to the product interface much nicer.
 
 
====pe-place_object_js====
 
'''This is the largest change in pluging into the page editor.'''  Because each object can now be moved individually in and out of cells, the html that is produced by your javascript must use a certain format.
 
 
For example, our Scrolling Newsbox used to place [[Plugging-in_to_the_Page_Editor#HTML_output|this]] html on our page.  Now our desired output looks like this.
 
<pre>
 
<div style="height: 50px;" class="droppedItem" id="SCROLLNEWSOBJ151050312">
 
  <img width="199" vspace="0" hspace="0" height="15" border="0" align="middle" style="cursor: move;" src="images/text_header.gif" />
 
  <br clear="all" />
 
  <font color="darkblue" style="font-family: Arial; font-size: 8pt;">
 
      <u>
 
        Scroll Box : test
 
      </u>
 
  </font>
 
  <!-- ##SCROLLNEWS;1## -->
 
</div>
 
<!-- ~~~ -->
 
</pre>
 
The page editor creates the following for you.  All you need to do is replace ##OBJ_DISPLAY## with your content.
 
<pre>
 
<div style="height: 50px;" class="droppedItem" id="SCROLLNEWSOBJ151050312">
 
  <img width="199" vspace="0" hspace="0" height="15" border="0" align="middle" style="cursor: move;" src="images/text_header.gif" />
 
  <br clear="all" />
 
  ##OBJ_DISPLAY##
 
</div>
 
<!-- ~~~ -->
 
</pre>
 
And finally, this is what our new scroll_js.php looks like.
 
 
<pre>
 
<pre>
 
function OkScrollData() {
 
function OkScrollData() {
   // Initialize vars
+
   doOperation = 0;
  var finalObj,RandNum;
+
    
   // Create drop item template with specific id
+
   var dataTrue = dataData.search("pixel.gif");
  // objTemplate accepts (id of layer, true/false use header img, height of drop item)
+
    
   var tmplt = objTemplate('SCROLLNEWSOBJ', true, 50);
+
   disOne = document.getElementById('scrollname').selectedIndex;
 
+
   tscrollval = eval("document.getElementById('scrollname').options["+disOne+"].value");
   // Get selected form values from properties layer
+
   tscrollname = eval("document.getElementById('scrollname').options["+disOne+"].innerHTML");
   disOne = $('scrollname').selectedIndex;
+
 
   tscrollval = eval("$('scrollname').options["+disOne+"].value");
+
   tscrollname = eval("$('scrollname').options["+disOne+"].innerHTML");
+
 
   tscrollname = tscrollname.toString();
 
   tscrollname = tscrollname.toString();
 
 
  // Content of layer
 
  var insertThis = "<font style='font-family: Arial; font-size: 8pt;'><U><font color=darkblue>Scroll Box : "+tscrollname+"</font></U></FONT><!-- ##SCROLLNEWS;"+tscrollval+"## -->";
 
  
   // Place content into template var
+
   TextHeader = "<img src=images/text_header.gif width=199 height=15 border=0 align=left vspace=0 hspace=0 style='cursor: move;'><BR CLEAR=ALL>";
   finalObj = tmplt[1].replace("##OBJ_DISPLAY##", insertThis);
+
   TableStart = "<table border=0 cellpadding=2 cellspacing=0 style='border: 1px inset black; background: #EFEFEF;'><tr><td width=199 align=center valign=top>";
 +
  TableEnd = "</td></tr></table><!-- ~~~ -->";
  
  // If user has selected a value, then insert template into cell
+
   if (dataTrue > 0) {
   if ($('scrollname').selectedIndex != 0) {
+
  sText = TableStart+TextHeader+"<font style='font-family: Arial; font-size: 8pt;'><U><font color=darkblue>Scroll Box : "+tscrollname+"</font></U></FONT><!-- ##SCROLLNEWS;"+tscrollval+"## -->"+TableEnd;
      document.getElementById(ColRowID).innerHTML= finalObj;
+
  doOperation = 1;
 +
  } else {
 +
  sText = dataData+"<BR>"+TableStart+TextHeader+"<font style='font-family: Arial; font-size: 8pt;'><U><font color=darkblue>Scroll Box : "+tscrollname+"</font></U></FONT><!-- ##SCROLLNEWS;"+tscrollval+"## -->"+TableEnd;
 +
  doOperation = 1;
 
   }
 
   }
 
    
 
    
   // Check row heights
+
   if (doOperation == 1) {
  checkRow(ColRowID)
+
  document.getElementById(ColRowID).innerHTML= sText;
 +
  document.getElementById(ColRowID).style.backgroundColor= "#FFFFFF";
 +
  }
 +
  document.getElementById('scrollname').selectedIndex = 0; // Reset Selection to Nothing(Null)
 
    
 
    
   // Reset Selection to Nothing(Null)
+
   if ( window.checkPageAreas ){
  $('scrollname').selectedIndex = 0;
+
      checkPageAreas('start');
 +
  }
 
}
 
}
 
</pre>
 
</pre>
  
 +
And thats it :)
  
 +
==Final note==
 +
The new page_editor.php uses a XHTML 1.0 Strict doctype and may effect the look/feel of your properties layer and will effect ill formed javascript.
  
 +
Meaning that the following is no longer acceptable javascript.
 +
<pre>
 +
myFoo = foo.selectedIndex;
 +
</pre>
 +
It must be
 +
<pre>
 +
myFoo = document.getElementById('foo').selectedIndex;
 +
</pre>
  
 
+
To test your code changes with the v4.9.3 version please enable installation of testing builds through Software Updates and install on a development domain.
 
+
 
+
==Final note==
+
I would encourage you to look at all the files that I have discussed. This may seem like a ton of information but it is really only a couple files.  Once you have finished one module the next will come much easier.  The scrolling newsbox took me a little over half a day to complete.
+
  
 
[[Category:Plugins]]
 
[[Category:Plugins]]

Latest revision as of 13:14, 27 November 2007

How To Update

Within your object javascript simply add the following to the end, that is, after you have placed your object into the cell.

if ( window.checkPageAreas ){
   checkPageAreas('start');
}

Our scrolling newsbox OkScrollData() function now looks like this.

function OkScrollData() {
   doOperation = 0;
   
   var dataTrue = dataData.search("pixel.gif");
   
   disOne = document.getElementById('scrollname').selectedIndex;
   tscrollval = eval("document.getElementById('scrollname').options["+disOne+"].value");
   tscrollname = eval("document.getElementById('scrollname').options["+disOne+"].innerHTML");
   
   tscrollname = tscrollname.toString();

   TextHeader = "<img src=images/text_header.gif width=199 height=15 border=0 align=left vspace=0 hspace=0 style='cursor: move;'><BR CLEAR=ALL>";
   TableStart = "<table border=0 cellpadding=2 cellspacing=0 style='border: 1px inset black; background: #EFEFEF;'><tr><td width=199 align=center valign=top>";
   TableEnd = "</td></tr></table><!-- ~~~ -->";

   if (dataTrue > 0) {
   	sText = TableStart+TextHeader+"<font style='font-family: Arial; font-size: 8pt;'><U><font color=darkblue>Scroll Box : "+tscrollname+"</font></U></FONT><!-- ##SCROLLNEWS;"+tscrollval+"## -->"+TableEnd;
   	doOperation = 1;
   } else {
   	sText = dataData+"<BR>"+TableStart+TextHeader+"<font style='font-family: Arial; font-size: 8pt;'><U><font color=darkblue>Scroll Box : "+tscrollname+"</font></U></FONT><!-- ##SCROLLNEWS;"+tscrollval+"## -->"+TableEnd;
   	doOperation = 1;
   }
   
   if (doOperation == 1) {
   	document.getElementById(ColRowID).innerHTML= sText;
   	document.getElementById(ColRowID).style.backgroundColor= "#FFFFFF";
   }
   document.getElementById('scrollname').selectedIndex = 0;	// Reset Selection to Nothing(Null)
   
   if ( window.checkPageAreas ){
      checkPageAreas('start');
   }
}

And thats it :)

Final note

The new page_editor.php uses a XHTML 1.0 Strict doctype and may effect the look/feel of your properties layer and will effect ill formed javascript.

Meaning that the following is no longer acceptable javascript.

myFoo = foo.selectedIndex;

It must be

myFoo = document.getElementById('foo').selectedIndex;

To test your code changes with the v4.9.3 version please enable installation of testing builds through Software Updates and install on a development domain.

Personal tools