Support for default buttons with Ctrl-Enter/Escpae hotkeys, arrow navigation in menus.
[fa-stable.git] / includes / ui / ui_controls.inc
index fd2fefb3474498153648790ef244950ac42e1ef9..fe23de17defe268336d8a5495da20ad7da0cfd66 100644 (file)
@@ -1,29 +1,29 @@
 <?php
 /**********************************************************************
-    Copyright (C) 2005-2008  FrontAccounting, LLC.
-       Released under the terms of the GNU Affero General Public License,
-       AGPL, as published by the Free Software Foundation, either version 
-       of the License, or (at your option) any later version.
+    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/agpl-3.0.html>.
+    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
@@ -56,6 +56,37 @@ 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;
@@ -94,7 +125,6 @@ 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>";
@@ -103,10 +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 . "'$pars[1]>$pars[0]</a>\n";
+       echo "<a href='$target' $id='$id' $pars[1]>$pars[0]</a>\n";
        if ($center)
                echo "</center>";
 }
@@ -118,14 +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'$pars[1]>$pars[0]</a>\n";
+       echo "<a id='$id' href='$target?$params'$pars[1]>$pars[0]</a>\n";
        if ($center)
                echo "</center>";
 }
@@ -141,10 +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 . "'$pars[1]>$pars[0]</a>\n";
+       echo "<a target='_blank' $id='$id' href='$target?$params' $pars[1]>$pars[0]</a>\n";
        if ($center)
                echo "</center>";
 }
@@ -172,56 +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($name, $value, $title=false, $icon=false)
-{
-       // php silently changes dots,spaces,'[' and characters 128-159
-       // to underscore in POST names, to maintain compatibility with register_globals
-       if (user_graphic_links() && $icon)
-       {
-               global $path_to_root;
-               $name = htmlentities(strtr($name, array('.'=>'=2E',' '=>'=20','='=>'=3D','['=>'=5B')));
-               echo "<button type='submit' class='editbutton' name='$name' value='' /><img src='$path_to_root/themes/".user_theme().
-               "/images/$icon' width='14' height='14' border='0' ".($title ? "title='$title'" : "title='$value'")." />\n";
-       }
-       else
-               echo "<input type=\"submit\" class=\"editbutton\" name=\""
-                       .htmlentities(strtr($name, array('.'=>'=2E',' '=>'=20','='=>'=3D','['=>'=5B')))
-                       ."\" value=\"$value\""
-                       .($title ? " title='$title'":'')." />\n";
-}
-
-function edit_button_cell($name, $value, $title=false, $icon=false)
-{
-       echo "<td>";
-       edit_button($name, $value, $title, $icon);
-       echo "</td>";
-}
-
 //-----------------------------------------------------------------------------------
 
 function start_row($param="")
@@ -345,5 +391,33 @@ function context_reset()
 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