API16

JHtmlJGrid/orderUp

From Joomla! Documentation

< API16:JHtmlJGrid
Revision as of 21:57, 13 May 2013 by JoomlaWikiBot (talk | contribs) (removing red link to edit, no existant pages)

The "API16" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Description[edit]

Create a order-up action icon.

[<! removed edit link to red link >]

<! removed transcluded page call, red link never existed >

Syntax[edit]

static orderUp($i, $task, $enabled=true, $alt= 'JGrid_Move_Up')
Parameter Name Default Value Description
$i The row index.
$task The task to fire.
$enabled true True to show the icon.
$alt 'JGrid_Move_Up' The image alternate text string.

Returns[edit]

string The HTML for the IMG tag.

Defined in[edit]

libraries/joomla/html/html/jgrid.php

Importing[edit]

jimport( 'joomla.html.html.jgrid' );

Source Body[edit]

public static function orderUp($i, $task, $enabled = true, $alt = 'JGrid_Move_Up')
{
        $alt = JText::_($alt);

        // TODO: Deal with hardcoded links.
        if ($enabled)
        {
                $html   = '<a href="#reorder" onclick="return listItemTask(\'cb'.$i.'\',\''.$task.'\')" title="'.$alt.'">';
                $html   .= JHTML::_('image','admin/uparrow.png', $alt, array( 'width' => 16, 'height' => 16, 'border' => 0), true);
                $html   .= '</a>';
        }
        else {
                $html   = JHTML::_('image','admin/uparrow0.png', $alt, array( 'width' => 16, 'height' => 16, 'border' => 0), true);
        }
        return $html;
}

[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >

Examples[edit]

<CodeExamplesForm />