Difference between revisions of "API:EPrints/Box"
| Line 70: | Line 70: | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
</div> | </div> | ||
| − | <!-- Pod2Wiki= | + | <!-- Pod2Wiki=item_$options{handle} --> |
| − | === | + | ===$options{handle}=== |
| − | + | $options{handle} | |
Current <tt>$handle</tt>. | Current <tt>$handle</tt>. | ||
| Line 83: | Line 83: | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
</div> | </div> | ||
| − | <!-- Pod2Wiki= | + | <!-- Pod2Wiki=item_$options{id} --> |
| − | === | + | ===$options{id}=== |
| − | + | $options{id} | |
ID attibute of the box. E.g. <div id="my_box"> | ID attibute of the box. E.g. <div id="my_box"> | ||
| Line 96: | Line 96: | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
</div> | </div> | ||
| − | <!-- Pod2Wiki= | + | <!-- Pod2Wiki=item_$options{title} --> |
| − | === | + | ===$options{title}=== |
| − | + | $options{title} | |
XHTML DOM of the title of the box. Note the exact object will be used not a clone of the object. | XHTML DOM of the title of the box. Note the exact object will be used not a clone of the object. | ||
| Line 109: | Line 109: | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
</div> | </div> | ||
| − | <!-- Pod2Wiki= | + | <!-- Pod2Wiki=item_$options{content} --> |
| − | === | + | ===$options{content}=== |
| − | + | $options{content} | |
XHTML DOM of the content of the box. Note the exact object will be used not a clone of the object. | XHTML DOM of the content of the box. Note the exact object will be used not a clone of the object. | ||
| Line 122: | Line 122: | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
</div> | </div> | ||
| − | <!-- Pod2Wiki= | + | <!-- Pod2Wiki=item_$options{collapsed} --> |
| − | === | + | ===$options{collapsed}=== |
| − | + | $options{collapsed} | |
Should the box start rolled up. Default to <tt>false</tt>. | Should the box start rolled up. Default to <tt>false</tt>. | ||
| Line 135: | Line 135: | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
</div> | </div> | ||
| − | <!-- Pod2Wiki= | + | <!-- Pod2Wiki=item_$options{content_style} --> |
| − | === | + | ===$options{content_style}=== |
| − | + | $options{content_style} | |
The CSS style to apply to the content box. E.g. <tt>overflow-y: auto; height: 300px;</tt> | The CSS style to apply to the content box. E.g. <tt>overflow-y: auto; height: 300px;</tt> | ||
| Line 148: | Line 148: | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
</div> | </div> | ||
| − | <!-- Pod2Wiki= | + | <!-- Pod2Wiki=item_$options{show_icon_url} --> |
| − | === | + | ===$options{show_icon_url}=== |
| − | + | $options{show_icon_url} | |
The URL of the icon to use instead of the '''[+]''' | The URL of the icon to use instead of the '''[+]''' | ||
| Line 161: | Line 161: | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
</div> | </div> | ||
| − | <!-- Pod2Wiki= | + | <!-- Pod2Wiki=item_$options{hide_icon_url} --> |
| − | === | + | ===$options{hide_icon_url}=== |
| − | + | $options{hide_icon_url} | |
The URL of the icon to use instead of the '''[-]''' | The URL of the icon to use instead of the '''[-]''' | ||
Revision as of 10:56, 4 March 2022
EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects
Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki
Contents
NAME
EPrints::Box - Class to render cute little collapsable/expandable Web 2.0ish boxes.
DESCRIPTION
This just provides a function to render boxes in the EPrints style.
SYNOPSIS
use EPrints;
# an XHTML DOM box with a title and some content that starts rolled up.
EPrints::Box(
handle => $handle,
id => "my_box",
title => $my_title_dom,
content => $my_content_dom,
collapsed => 1,
);
METHODS
render
$box_xhtmldom = EPrints::Box::render( %options )
Render a collapsable/expandable box to which content can be added. The box is in keeping with the eprints style.
Required Options:
$options{handle}
$options{handle}
Current $handle.
$options{id}
$options{id}
ID attibute of the box. E.g. <div id="my_box">
$options{title}
$options{title}
XHTML DOM of the title of the box. Note the exact object will be used not a clone of the object.
$options{content}
$options{content}
XHTML DOM of the content of the box. Note the exact object will be used not a clone of the object.
$options{collapsed}
$options{collapsed}
Should the box start rolled up. Default to false.
$options{content_style}
$options{content_style}
The CSS style to apply to the content box. E.g. overflow-y: auto; height: 300px;
$options{show_icon_url}
$options{show_icon_url}
The URL of the icon to use instead of the [+]
$options{hide_icon_url}
$options{hide_icon_url}
The URL of the icon to use instead of the [-]
COPYRIGHT
© Copyright 2023 University of Southampton.
EPrints 3.4 is supplied by EPrints Services.
http://www.eprints.org/eprints-3.4/
LICENSE
This file is part of EPrints 3.4 http://www.eprints.org/.
EPrints 3.4 and this file are released under the terms of the GNU Lesser General Public License version 3 as published by the Free Software Foundation unless otherwise stated.
EPrints 3.4 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 GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with EPrints 3.4. If not, see http://www.gnu.org/licenses/.
