Difference between revisions of "API:EPrints/Box"

From EPrints Documentation
Jump to: navigation, search
(New page: <!-- Pod2Wiki=_preamble_ This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost. -...)
 
 
(17 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
<!-- Pod2Wiki=_preamble_  
 
<!-- Pod2Wiki=_preamble_  
−
This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost.
+
This page has been automatically generated from the EPrints 3.4 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
−
  -->{{Pod2Wiki}}{{API:Source|file=EPrints/Box.pm|package_name=EPrints::Box}}[[Category:API|Box]]<!-- End of Pod2Wiki -->
+
  -->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Box.pm|package_name=EPrints::Box}}[[Category:API|BOX]]<div><!-- Edit below this comment -->
−
<!-- Pod2Wiki=head_name -->=NAME=
 
−
'''EPrints::Box''' - Class to render cute little Web 2.0ish boxes.
 
  
−
<!-- End of Pod2Wiki -->
+
 
−
<!-- Pod2Wiki=head_description -->=DESCRIPTION=
+
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
 +
==NAME==
 +
'''EPrints::Box''' - Class to render cute little collapsable/expandable  Web 2.0ish boxes.
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_description -->
 +
==DESCRIPTION==
 
This just provides a function to render boxes in the EPrints style.
 
This just provides a function to render boxes in the EPrints style.
  
−
<!-- End of Pod2Wiki -->
+
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
−
<!-- Pod2Wiki=item_render -->==render==
+
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_synopsis -->
 +
===SYNOPSIS===
 +
  use EPrints;
 +
 
 +
  # an XHTML DOM box with a title and some content that starts rolled up.
 +
  EPrints::Box(
 +
      handle =&gt; $handle,
 +
          id =&gt; "my_box",
 +
        title =&gt; $my_title_dom,
 +
      content =&gt; $my_content_dom,
 +
    collapsed =&gt; 1,
 +
  );
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_methods -->
 +
==METHODS==
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
  
−
  $box_xhtmldom = EPrints::Box::render( %options )
 
  
−
Render a cute box.
+
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_render -->
 +
===render===
  
−
Options:
+
$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.
  
−
<!-- End of Pod2Wiki -->
+
Required Options:
−
<!-- Pod2Wiki=item_session -->==session==
 
  
−
  session: Current $session (required)
+
'''<tt>$options{handle}</tt>''' - Current <tt>$handle</tt>.
  
−
<!-- End of Pod2Wiki -->
+
'''<tt>$options{id}</tt>''' - ID attibute of the box. E.g. &lt;div id="my_box"&gt;
−
<!-- Pod2Wiki=item_box -->==box==
 
  
−
  id: XML ID of box (required)
+
'''<tt>$options{title}</tt>''' - XHTML DOM of the title of the box. N.B. The exact  object will be used not a clone of the object.
  
−
<!-- End of Pod2Wiki -->
+
'''<tt>$options{content}</tt>''' - XHTML DOM of the content of the box. N.B. The  exact object will be used not a clone of the object.
−
<!-- Pod2Wiki=item_title -->==title==
 
  
−
  title: XHTML DOM of title (required). Nb. Will not be cloned.
+
Optional Options:
  
−
<!-- End of Pod2Wiki -->
+
'''<tt>$options{collapsed}</tt>''' -Should the box start rolled up. Defaults to  <tt>false</tt>.
−
<!-- Pod2Wiki=item_content -->==content==
 
  
−
  content: XHTML DOM of content (required). Nb. Will not be cloned.
+
'''<tt>$options{content_style}</tt>''' - The CSS style to apply to the content box. E.g. <tt>overflow-y: auto; height: 300px;</tt>
  
−
<!-- End of Pod2Wiki -->
+
'''<tt>$options{show_icon_url}</tt>''' - The URL of the icon to use instead of the  '''[+]'''
−
<!-- Pod2Wiki=item_collapsed_boolean_default_to_false -->==collapsed_boolean_default_to_false==
 
  
−
  collapsed: boolean. Default to false.
+
'''<tt>$options{hide_icon_url}</tt>''' - The URL of the icon to use instead of the  '''[-]'''
  
−
<!-- End of Pod2Wiki -->
+
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
−
<!-- Pod2Wiki=item_content_style_the_css_style_to_apply_to_the_content_box_for_example_overflow_y_auto_height_300px -->==content_style_the_css_style_to_apply_to_the_content_box_for_example_overflow_y_auto_height_300px==
+
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
  
−
  content-style: the css style to apply to the content box. For example; "overflow-y: auto; height: 300px;"
 
  
−
<!-- End of Pod2Wiki -->
+
<!-- Pod2Wiki= -->
−
<!-- Pod2Wiki=item_show_icon_url_and_hide_icon_url_the_icons_to_show_instead_of_the_default_and -->==show_icon_url_and_hide_icon_url_the_icons_to_show_instead_of_the_default_and==
+
</div>
 +
<!-- Pod2Wiki=head_copyright -->
 +
==COPYRIGHT==
 +
{{API:Copyright}}
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
  
−
  show_icon_url and hide_icon_url: the icons to show instead of the default [+] and [-]
 
  
−
<!-- End of Pod2Wiki -->
+
<!-- Pod2Wiki= -->
−
<!-- Pod2Wiki=_postamble_ --><!-- End of Pod2Wiki -->
+
</div>
 +
<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->

Latest revision as of 11:06, 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

API: Core API

Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki


NAME

EPrints::Box - Class to render cute little collapsable/expandable Web 2.0ish boxes.

User Comments


DESCRIPTION

This just provides a function to render boxes in the EPrints style.

User Comments


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,
 );

User Comments


METHODS

User Comments


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} - Current $handle.

$options{id} - ID attibute of the box. E.g. <div id="my_box">

$options{title} - XHTML DOM of the title of the box. N.B. The exact object will be used not a clone of the object.

$options{content} - XHTML DOM of the content of the box. N.B. The exact object will be used not a clone of the object.

Optional Options:

$options{collapsed} -Should the box start rolled up. Defaults to false.

$options{content_style} - The CSS style to apply to the content box. E.g. overflow-y: auto; height: 300px;

$options{show_icon_url} - The URL of the icon to use instead of the [+]

$options{hide_icon_url} - The URL of the icon to use instead of the [-]

User Comments


COPYRIGHT

© Copyright 2000-2024 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/.

User Comments


Retrieved from ‘https://wiki.eprints.org/w/index.php?title=API:EPrints/Box&oldid=14853’