Class ::xo::Page

::xo::Page[i] create ...

Defined in

Class Relations

  • class: ::xotcl::Class[i]
  • superclass: ::xotcl::Object[i]
::xotcl::Class create ::xo::Page \
     -superclass ::xotcl::Object

Methods (to be applied on the object)

  • get_property (scripted, public)

     xo::Page[i] get_property name

    Return the element and value pairs for a named page property, or an empty list.

    Parameters:
    name (required)
    Property name.

    Testcases:
    xowiki_test_cases, create_form_with_form_instance
    if {[array exists ::xo_property_${name}]} {
      return [array get ::xo_property_${name}]
    }
    return [list]
  • header_stuff (scripted, public)

     xo::Page[i] header_stuff

    Add the registered styles, stylesheets, and scripts to the template head.

    Returns:
    The empty string.

    Testcases:
    xowiki_test_cases
    
    foreach style [:sort_keys_by_value [array get ::_xo_need_style]] {
      template::head::add_style -style $style
    }
    set count 10
    foreach file [:sort_keys_by_value [array get ::_xo_need_css]] {
      template::head::add_css -href $file -media all -order [incr count]
    }
    if {[info exists ::_xo_js_order]} {
      set statements ""
      set order 10
      foreach file $::_xo_js_order {
        if {[string match "*;*" $file]} {
          # it is not a file, but some JavaScript statements
          #append statements [string map {< "&lt;" > "&gt;"} $file] \n
          append statements $file \n
        } else {
          template::head::add_script -src $file -type text/javascript -order [incr order]
        }
      }
      if {$statements ne ""} {
        template::head::add_script -script $statements -type text/javascript -order [incr order]
      }
    }
    return ""
  • requireCSS (scripted, public)

     xo::Page[i] requireCSS [ -order order ] name

    Register a stylesheet for the page head.

    Switches:
    -order (optional, defaults to "1")
    Relative order group for stylesheets.
    Parameters:
    name (required)
    Stylesheet URL.

    Testcases:
    create_workflow_with_instance, xowiki_test_cases, path_resolve
    set ::_xo_need_css($name) [expr {[array size ::_xo_need_css] + 1000 * $order}]
  • requireJS (scripted, public)

     xo::Page[i] requireJS name

    Register a JavaScript URL or inline statements for the page head. Repeated registrations retain their first position.

    Parameters:
    name (required)
    Script URL, or inline JavaScript containing a semicolon.

    Testcases:
    path_resolve
    if {![info exists ::_xo_need_js($name)]} {lappend ::_xo_js_order $name}
    set ::_xo_need_js($name)  1
  • requireLink (scripted)

    template::head::add_link -rel $rel -href $href -type $type -title $title
  • requireStyle (scripted)

    set ::_xo_need_style($s) [expr {[array size ::_xo_need_style] + 1000 * $order}]
  • set_property (scripted, public)

     xo::Page[i] set_property name element value

    Store a value under an element of a named page property.

    Parameters:
    name (required)
    Property name.
    element (required)
    Element key.
    value (required)
    Value to store.

    Testcases:
    xowiki_test_cases, create_form_with_form_instance
    set ::xo_property_${name}($element) $value
  • sort_keys_by_value (scripted)

    set result [list]
    set a [list]
    foreach {key value} $pairs {
      lappend a [list $key $value]
    }
    foreach pair [lsort -index 1 -$comparison -$direction $a] {
      lappend result [lindex $pair 0]
    }
    return $result