[#ZF-7890] Add ability to specify a rootnode type for customDijit's - Zend Framework Issue Tracker

Details

Type: Improvement
Status: Resolved
Priority: Major
Resolution: Fixed
Affects Version/s: None
Fix Version/s: 1.9.5
Component/s: Zend_Dojo
Labels:
None

Description

Currently, there doesn't appear to be a way to specify which type of root node will be used for instantiating a customDijit. I believe the default is a <div>, but for semantic reasons it might be better to specify a custom element type to ensure a page could degrade gracefully.

My example would be a custom multiselect from dojox. It doesn't require a <select> element to be the root, but <div><option></option></div> isn't valid markup and could have unpredictable results (nor would it degrade). (Note: the issue doesn't exist if you are using a datastore with this widget, as all markup instantiation is done for you, but the overall implication would suggest having a root node setting would be best, hence this ticket)

Activity

Ascending order - Click to sort in descending order

Hide

Permalink

Matthew Weier O'Phinney added a comment - 22/Oct/09 11:30 AM

You can now pass 'rootNode' as one of the params to a customDijit; ability added in trunk and merged to 1.9 release branch.

Show

Matthew Weier O'Phinney added a comment - 22/Oct/09 11:30 AM You can now pass 'rootNode' as one of the params to a customDijit; ability added in trunk and merged to 1.9 release branch.

Hide

Permalink

Tridem added a comment - 03/Feb/12 12:58 PM

The parameter 'rootNode' is only accepted when using customDijit without capture.

<?php echo $this->customDijit()->captureStart(
    'foo',
    array(
        'dojoType' => 'dijit.layout.AccordionPane',
        'title'    => 'Not accepting root node in customDijit capture.',
        'rootNode' => 'h2'
    ),
    array(
        'rootNode' => 'h2'
    )
); ?>
Not accepting root node in customDijit capture.
<?php echo $this->customDijit()->captureEnd('foo'); ?>

<?php echo $this->accordionPane()->captureStart(
    'foo2',
    array(
        'dojoType' => 'dijit.layout.AccordionPane',
        'title'    => 'Not accepting root node in accordionPane capture.',
        'rootNode' => 'h2'
    ),
    array(
        'rootNode' => 'h2'
    )
); ?>
Not accepting root node in accordionPane capture.
<?php echo $this->accordionPane()->captureEnd('foo2'); ?>

<?php echo $this->customDijit(
    'bar',
    'Accepting root node.',
    array(
        'dojoType' => 'dijit.layout.AccordionPane',
        'title'    => 'Accepting root node.',
        'rootNode' => 'h2'
    )
); ?>

<?php echo $this->accordionPane(
    'bar2',
    'Not accepting root node in accordionPane.',
    array(
        'title'    => 'Not accepting root node in accordionPane.',
        'rootNode' => 'h2'
    ),
    array(
        'style' => 'background-color: lightgray;',
        'title'    => 'Not accepting root node in accordionPane.',
        'rootNode' => 'h2'
    )
); ?>

HTML Result:

<div rootNode="h2" id="foo">Not accepting root node in customDijit capture.
</div>

<div rootNode="h2" id="foo2">Not accepting root node in accordionPane capture.
</div>

<h2 id="bar">Accepting root node.</h2>

<div style="background-color: lightgray;" title="Not accepting root node in accordionPane." rootNode="h2" id="bar2">Not accepting root node in accordionPane.</div>

The 'h2' node is never set on the other examples no matter where you put it. The result is the same when using dojo declarative or programmatic mode.

It would be really great if existin view helpers like 'accordionPane' would also accept the 'rootNode' parameter.

I guess the following customDijit lines should then be passed to Zend_Dojo_View_Helper_DijitContainer:

if (array_key_exists('rootNode', $params)) {
            $this->setRootNode($params['rootNode']);
            unset($params['rootNode']);
        }

Show

Tridem added a comment - 03/Feb/12 12:58 PM The parameter 'rootNode' is only accepted when using customDijit without capture.

<?php echo $this->customDijit()->captureStart(
    'foo',
    array(
        'dojoType' => 'dijit.layout.AccordionPane',
        'title'    => 'Not accepting root node in customDijit capture.',
        'rootNode' => 'h2'
    ),
    array(
        'rootNode' => 'h2'
    )
); ?>
Not accepting root node in customDijit capture.
<?php echo $this->customDijit()->captureEnd('foo'); ?>

<?php echo $this->accordionPane()->captureStart(
    'foo2',
    array(
        'dojoType' => 'dijit.layout.AccordionPane',
        'title'    => 'Not accepting root node in accordionPane capture.',
        'rootNode' => 'h2'
    ),
    array(
        'rootNode' => 'h2'
    )
); ?>
Not accepting root node in accordionPane capture.
<?php echo $this->accordionPane()->captureEnd('foo2'); ?>

<?php echo $this->customDijit(
    'bar',
    'Accepting root node.',
    array(
        'dojoType' => 'dijit.layout.AccordionPane',
        'title'    => 'Accepting root node.',
        'rootNode' => 'h2'
    )
); ?>

<?php echo $this->accordionPane(
    'bar2',
    'Not accepting root node in accordionPane.',
    array(
        'title'    => 'Not accepting root node in accordionPane.',
        'rootNode' => 'h2'
    ),
    array(
        'style' => 'background-color: lightgray;',
        'title'    => 'Not accepting root node in accordionPane.',
        'rootNode' => 'h2'
    )
); ?>

HTML Result:

<div rootNode="h2" id="foo">Not accepting root node in customDijit capture.
</div>

<div rootNode="h2" id="foo2">Not accepting root node in accordionPane capture.
</div>

<h2 id="bar">Accepting root node.</h2>

<div style="background-color: lightgray;" title="Not accepting root node in accordionPane." rootNode="h2" id="bar2">Not accepting root node in accordionPane.</div>

The 'h2' node is never set on the other examples no matter where you put it. The result is the same when using dojo declarative or programmatic mode. It would be really great if existin view helpers like 'accordionPane' would also accept the 'rootNode' parameter. I guess the following customDijit lines should then be passed to Zend_Dojo_View_Helper_DijitContainer:

if (array_key_exists('rootNode', $params)) {
            $this->setRootNode($params['rootNode']);
            unset($params['rootNode']);
        }

Zend Framework

Add ability to specify a rootnode type for customDijit's

Details

Description

Activity

People

Dates