Support for default buttons with Ctrl-Enter/Escpae hotkeys, arrow navigation in menus.
[fa-stable.git] / includes / ui / ui_controls.inc
index d9d1f05759994e08cb910ad7fbb22cea81e9755f..fe23de17defe268336d8a5495da20ad7da0cfd66 100644 (file)
@@ -1,20 +1,29 @@
 <?php
-
+/**********************************************************************
+    Copyright (C) FrontAccounting, LLC.
+       Released under the terms of the GNU General Public License, GPL, 
+       as published by the Free Software Foundation, either version 3 
+       of the License, or (at your option) any later version.
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  
+    See the License here <http://www.gnu.org/licenses/gpl-3.0.html>.
+***********************************************************************/
+function get_post($name, $dflt='')
+{
+       return ((!isset($_POST[$name]) || $_POST[$name] === '') ? $dflt : $_POST[$name]);
+}
 //---------------------------------------------------------------------------------
 
-function start_form($multi=false, $sid=false, $action="", $name="")
+function start_form($multi=false, $dummy=false, $action="", $name="")
 {
+       // $dummy - leaved for compatibility with 2.0 API
+
        if ($name != "")
                $name = "name='$name'";
        if ($action == "")
                $action = $_SERVER['PHP_SELF'];
-       if ($sid)
-       {
-               if (strpos($action, "?"))
-                       $action .= "&" . SID;
-               else
-                       $action .= "?" . SID;
-       }
+
        if ($multi)
                echo "<form enctype='multipart/form-data' method='post' action='$action' $name>\n";
        else
@@ -28,7 +37,7 @@ function end_form($breaks=0)
 {
        if ($breaks)
                br($breaks);
-       echo "<input type=\"hidden\" name=\"_focus\" value=\"".$_POST['_focus']."\">\n";
+       echo "<input type=\"hidden\" name=\"_focus\" value=\"".get_post('_focus')."\">\n";
        echo "</form>\n";
 }
 
@@ -47,23 +56,75 @@ function end_table($breaks=0)
                br($breaks);
 }
 
+function start_outer_table($extra="", $padding='2', $spacing='0', $br=false)
+{
+       if ($br)
+               br();
+       start_table($extra, $padding, $spacing);
+       echo "<tr valign=top><td>\n"; // outer table
+}
+
+function table_section($number=1, $width=false)
+{
+       if ($number > 1)
+       {
+               echo "</table>\n";
+               $width = ($width ? "width=$width" : "");
+               echo "</td><td class='tableseparator' $width>\n"; // outer table
+       }
+       echo "<table>\n";
+}      
+
+function end_outer_table($breaks=0, $close_table=true)
+{
+       if ($close_table)
+               echo "</table>\n";
+       echo "</td></tr>\n";
+       end_table($breaks);
+}
+
+function vertical_space()
+{
+       echo "</td></tr><tr><td valign=center>"; // outer table
+}
 function meta_forward($forward_to, $params="")
 {
     global $Ajax;
        echo "<meta http-equiv='Refresh' content='0; url=$forward_to?$params'>\n";
        echo "<center><br>" . _("You should automatically be forwarded.");
-       echo " " . _("If this does not happen") . " " . "<a href='$forward_to'>" . _("click here") . "</a> " . _("to continue") . ".<br><br></center>\n";
-       $Ajax->redirect($forward_to.'?'.$params);
+       echo " " . _("If this does not happen") . " " . "<a href='$forward_to?$params'>" . _("click here") . "</a> " . _("to continue") . ".<br><br></center>\n";
+       if ($params !='') $params = '?'.$params;
+       $Ajax->redirect($forward_to.$params);
        exit;
 }
 
 //-----------------------------------------------------------------------------------
+// Find and replace hotkey marker.
+// if $clean == true marker is removed and clean label is returned 
+// (for use in wiki help system), otherwise result is array of label 
+// with underlined hotkey letter and access property string.
+//
+function access_string($label, $clean=false)
+{
+       $access = '';
+       $slices = array();
+
+       if (preg_match('/(.*)&([a-zA-Z0-9])(.*)/', $label, $slices))    
+       {
+               $label = $clean ? $slices[1].$slices[2].$slices[3] :
+                       $slices[1].'<u>'.$slices[2].'</u>'.$slices[3];
+               $access = " accesskey='".strtoupper($slices[2])."'";
+       }
+       
+       $label = str_replace( '&&', '&', $label);
+
+       return $clean ? $label : array($label, $access);
+}
 
 function hyperlink_back($center=true)
 {
        if ($center)
                echo "<center>";
-       //echo "<a href='javascript:goBack();'>"._("Back")."</a>\n";
        echo "<p><a href='javascript:goBack();'>"._("Back")."</a></p>\n";
        if ($center)
                echo "</center>";
@@ -72,9 +133,11 @@ function hyperlink_back($center=true)
 
 function hyperlink_no_params($target, $label, $center=true)
 {
+       $id = default_focus();
+       $pars = access_string($label);
        if ($center)
                echo "<br><center>";
-       echo "<a href='$target?=" . SID . "'>$label</a>\n";
+       echo "<a href='$target' $id='$id' $pars[1]>$pars[0]</a>\n";
        if ($center)
                echo "</center>";
 }
@@ -86,13 +149,65 @@ function hyperlink_no_params_td($target, $label)
        echo "</td>\n";
 }
 
+function viewer_link($label, $url='', $class='', $id='',  $icon=null)
+{
+       global $path_to_root;
+       
+       if ($class != '')
+               $class = " class='$class'";
+
+       if ($id != '')
+               $class = " id='$id'";
+
+       if ($url != "")
+       {
+               $pars = access_string($label);
+               if (user_graphic_links() && $icon)
+                       $pars[0] = set_icon($icon, $pars[0]);
+               $preview_str = "<a target='_blank' $class $id href='$path_to_root/$url' onclick=\"javascript:openWindow(this.href,this.target); return false;\"$pars[1]>$pars[0]</a>";
+       }
+       else
+               $preview_str = $label;
+
+ return $preview_str;
+}
+
+function menu_link($url, $label, $id=null)
+{
+
+       $id = default_focus($id);
+       $pars = access_string($label);
+       return "<a href='$url' class='menu_option' id='$id' $pars[1]>$pars[0]</a>";
+}
+
+function submenu_option($title, $url, $id=null)
+{
+       global $path_to_root;
+       display_note(menu_link($path_to_root . $url, $title, $id));
+       echo '<br>';
+}
+
+function submenu_view($title, $type, $number, $id=null)
+{
+       display_note(get_trans_view_str($type, $number, $title, false, 'menu_option', $id));
+       echo '<br>';
+}
+
+function submenu_print($title, $type, $number, $id=null)
+{
+       display_note(print_document_link($number, $title, true, $type, false, 'menu_option', $id));
+       echo '<br>';
+}
 //-----------------------------------------------------------------------------------
 
 function hyperlink_params($target, $label, $params, $center=true)
 {
+       $id = default_focus();
+       
+       $pars = access_string($label);
        if ($center)
                echo "<br><center>";
-       echo "<a href='$target?$params'>$label</a>\n";
+       echo "<a id='$id' href='$target?$params'$pars[1]>$pars[0]</a>\n";
        if ($center)
                echo "</center>";
 }
@@ -100,7 +215,7 @@ function hyperlink_params($target, $label, $params, $center=true)
 function hyperlink_params_td($target, $label, $params)
 {
        echo "<td>";
-       hyperlink_params($target, $label, $params);
+       hyperlink_params($target, $label, $params, false);
        echo "</td>\n";
 }
 
@@ -108,9 +223,12 @@ function hyperlink_params_td($target, $label, $params)
 
 function hyperlink_params_separate($target, $label, $params, $center=false)
 {
+       $id = default_focus();
+
+       $pars = access_string($label);
        if ($center)
                echo "<br><center>";
-       echo "<a target='_blank' href='$target?$params" . SID . "'>$label</a>\n";
+       echo "<a target='_blank' $id='$id' href='$target?$params' $pars[1]>$pars[0]</a>\n";
        if ($center)
                echo "</center>";
 }
@@ -138,37 +256,18 @@ function alt_table_row_color(&$k)
        }
 }
 
-function table_section_title($msg)
+function table_section_title($msg, $colspan=2)
 {
-       echo "<tr><td colspan=2 class='tableheader'>$msg</td><tr>\n";
+       echo "<tr><td colspan=$colspan class='tableheader'>$msg</td></tr>\n";
 }
 
-function table_header($labels)
+function table_header($labels, $params='')
 {
        start_row();
        foreach ($labels as $label)
-               labelheader_cell($label);
+               labelheader_cell($label, $params);
        end_row();
 }
-
-function edit_link_cell($param, $title=false)
-{
-    label_cell("<a href='" . $_SERVER['PHP_SELF']. "?" . "$param'"
-        .($title ? " title='$title'":'').">" . _("Edit") . "</a>", "nowrap");
-}
-
-function delete_link_cell($param, $title=false)
-{
-    label_cell("<a href='" . $_SERVER['PHP_SELF']. "?" . "$param'"
-       .($title ? " title='$title'":'') .">" . _("Delete") . "</a>", "nowrap");
-}
-
-function edit_button_cell($name, $value, $title=false)
-{
-    label_cell("<input type=\"submit\" class=\"editbutton\" name=\"$name\" value=\"$value\""
-       .($title ? " title='$title'":'')." />\n");
-}
-
 //-----------------------------------------------------------------------------------
 
 function start_row($param="")
@@ -192,13 +291,18 @@ function br($num=1)
 
 $ajax_divs = array();
 
-function div_start($id='')
+function div_start($id='', $trigger=null, $non_ajax=false)
 {
     global $ajax_divs;
 
-    array_push($ajax_divs, $id);
-    echo "<div ". ($id !='' ? "id='$id'" : '').">";
-    ob_start();
+       if ($non_ajax) { // div for non-ajax elements
+               array_push($ajax_divs, array($id, null));
+               echo "<div style='display:none' class='js_only' ".($id !='' ? "id='$id'" : '').">";
+       } else { // ajax ready div
+               array_push($ajax_divs, array($id, $trigger===null ? $id : $trigger));
+               echo "<div ". ($id !='' ? "id='$id'" : '').">";
+               ob_start();
+       }
 }
 
 function div_end()
@@ -207,9 +311,113 @@ function div_end()
 
     if (count($ajax_divs))
     {
-               $id = array_pop($ajax_divs);
-               $Ajax->addUpdate($id, $id, ob_get_flush());
+               $div = array_pop($ajax_divs);
+               if ($div[1] !== null)
+                       $Ajax->addUpdate($div[1], $div[0], ob_get_flush());
                echo "</div>";
     }
 }
+
+/*
+       External page call with saving current context.
+       $call - url of external page
+       $ctx - optional. name of SESSION context object or array of names of POST 
+               variables saved on call
+*/
+function context_call($call, $ctx='')
+{
+       if (is_array($ctx)) 
+       {
+               foreach($ctx as $postname)
+               {
+                       $context[$postname] = get_post($postname);
+               }
+       } else 
+               $context = isset($_SESSION[$ctx]) ? $_SESSION[$ctx] : null;
+
+       array_unshift($_SESSION['Context'], array('name' => $ctx, 
+               'ctx' => $context,
+               'caller' => $_SERVER['PHP_SELF'],
+               'ret' => array()));
+       meta_forward($call);
+}
+/*
+       Restores context after external page call and
+       returns array of data passed by external page.
+*/
+function context_restore()
+{
+       if ( count($_SESSION['Context'])) {
+               if ($_SERVER['PHP_SELF'] == $_SESSION['Context'][0]['caller']) {
+                       $ctx = array_shift($_SESSION['Context']);
+                       if ($ctx) {
+                               if (is_array($ctx['ctx'])) {
+                                       foreach($ctx['ctx'] as $name => $val) 
+                                       {
+                                               $_POST[$name] = $val;
+                                       }
+                               } else
+                                       if ($ctx['name']!='')
+                                               $_SESSION[$ctx['name']] = $ctx['ctx'];
+                               return $ctx['ret'];
+                       }
+               }
+       }
+       return false;
+}
+
+/*
+       Return to caller page if the page was called from external context.
+*/
+function context_return($ret)
+{
+       if ( count($_SESSION['Context'])) {
+               $ctx = &$_SESSION['Context'][0];
+               $ctx['ret'] = $ret;
+               meta_forward( $ctx['caller'] );
+       }
+}
+/*
+       Clearing context stack after page cancel.
+*/
+function context_reset()
+{
+       $_SESSION['Context'] = array();
+}
+
+/*
+       Context stack initialization
+*/
+if (!isset($_SESSION['Context'])) {
+               context_reset();
+}
+/*
+       Redirector for selector F4 calls.
+       $sel_editors is array of selname=>editor_page
+*/
+function editor_redirect($sel_editors, $save_fun='') {
+       foreach ($sel_editors as $selname=>$editor)
+               if (isset($_POST['_'.$selname.'_editor'])) {
+                       if (function_exists($save_fun))
+                               $save_fun();
+                       unset($_POST['_'.$selname.'_editor']);
+                       context_call($editor, array_keys($_POST));
+               }
+}
+/*
+       Return procedure for selector F4 calls
+*/
+function editor_return($vars, $restore_fun='') {
+       if (function_exists($restore_fun))
+               $restore_fun();
+
+       if ($ret = context_restore()) {
+               foreach ($vars as $postname=>$retname)
+                       if (isset($ret[$retname])) {
+                               $_POST[$postname] = $ret[$retname];
+                               set_focus($postname);
+                       }
+       }
+}
+
 ?>
\ No newline at end of file