API:EPrints/Box

From EPrints Documentation
Revision as of 18:28, 11 August 2009 by Tdb01r (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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

NAME

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

DESCRIPTION

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

render

 $box_xhtmldom = EPrints::Box::render( %options )

Render a cute box.

Options:

session

 session: Current $session (required)

box

 id: XML ID of box (required)

title

 title: XHTML DOM of title (required). Nb. Will not be cloned.

content

 content: XHTML DOM of content (required). Nb. Will not be cloned.

collapsed_boolean_default_to_false

 collapsed: boolean. Default to false.

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;"

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 [-]