---

::xowiki::IncludeletClass ::xowiki::includelet::html-file

Class Hierarchy of ::xowiki::includelet::html-file

• ::xotcl::Object

  Meta-class:

  ::xotcl::Class

  Methods for instances:

  __api_make_doc, __api_make_forward_doc, __timediff, abstract, ad_doc, ad_forward, ad_proc, append^C, array^C, asHTML, autoname^C, check, class^C, cleanup^C, configure^C, contains^C, copy^C, db_0or1row^C, db_1row^C, debug, defaultmethod^C, destroy^C, destroy_on_cleanup, ds, eval^C, exists^C, extractConfigureArg, filter^C, filterguard^C, filtersearch, forward, hasclass, incr^C, info^C, init, instvar^C, invar^C, isclass, ismetaclass, ismixin, isobject, istype, lappend^C, log, method, mixin^C, mixinguard^C, move^C, msg, noinit^C, objectparameter, parametercmd^C, proc, procsearch, qn, requireNamespace^C, residualargs^C, self, serialize, set^C, set_instance_vars_defaults, show-object, subst^C, trace^C, unknown, unset^C, uplevel^C, upvar^C, volatile^C, vwait

  Methods to be applied on the class (in addition to the methods provided by the meta-class):

  getExitHandler, setExitHandler, unsetExitHandler

• ::xo::Context

  Meta-class:

  ::xotcl::Class

  Parameter for instances:

  actual_query (default " "), locale, package_id (default "0"), parameter_declaration (default "")

  Methods for instances:

  exists_query_parameter, export_vars, get_all_query_parameter, get_parameters, initialize, original_url_and_query, process_query_parameter, query_parameter

  Methods to be applied on the class:

  Methods provided by the meta-class

• ::xowiki::Includelet

  Meta-class:

  ::xotcl::Class

  Parameter for instances:

  __decoration (default "portlet"), id, name (default ""), parameter_declaration (default ""), title (default "")

  Methods for instances:

  category_clause, get_page_order, include_head_entries, initialize, js_name, resolve_page_name, screen_name

  Methods to be applied on the class (in addition to the methods provided by the meta-class):

  available_includelets, describe_includelets, glob_clause, html_encode, html_id, html_to_text, js_encode, js_name, listing, locale_clause, parent_id_clause, publish_status_clause, require_YUI_CSS, require_YUI_JS

• ::xowiki::includelet::html-file

  Meta-class:

  ::xowiki::IncludeletClass

  Parameter for instances:

  parameter_declaration (default " {-title ""} {-extra_css ""} {-levels 0} {-file:required} ")

  Methods for instances:

  href, page_number, render

  Methods to be applied on the class:

  Methods provided by the meta-class

Class Relations

• superclass: ::xowiki::Includelet

::xowiki::IncludeletClass create ::xowiki::includelet::html-file \
     -superclass ::xowiki::Includelet \
     -parameter {{parameter_declaration {
	  {-title ""}
	  {-extra_css ""}
	  {-levels 0}
	  {-file:required}
        }}}

Methods

• instproc href

  ::xowiki::policy5 instproc href {book_mode name} {
      my instvar package_id __including_page
      if {$book_mode} {
        set href [::xo::cc url]#[toc anchor $name]
      } else {
        set href [$package_id pretty_link -parent_id [$__including_page parent_id] $name]
      }
      return $href
    }
  

• instproc page_number

  ::xowiki::policy5 instproc page_number {page_order remove_levels} {
      #my log "o: $page_order"
      set displayed_page_order $page_order
      for {set i 0} {$i < $remove_levels} {incr i} {
        regsub {^[^.]+[.]} $displayed_page_order "" displayed_page_order
      }
      #return $displayed_page_order
      return ""
    }
  

• instproc render

  ::xowiki::policy5 instproc render {} {
      my get_parameters
      
      if {$title eq ""} {set title $file}
      set parent_id [[my set __including_page] parent_id]
      set page [$package_id get_page_from_item_ref -parent_id $parent_id $file]
      if {$page eq ""} {
        error "could not resolve page from item ref $file"
      }
      if {$extra_css ne ""} {foreach css $extra_css {::xo::Page requireCSS $css}}
      return [$page html_content -add_sections_to_folder_tree $levels -owner [self]]
    }
  

Variables

::xowiki::includelet::html-file set __default_metaclass ::xotcl::Class
::xowiki::includelet::html-file set __default_superclass ::xotcl::Object
::xowiki::includelet::html-file set aggregating false
::xowiki::includelet::html-file set cacheable false
::xowiki::includelet::html-file set localized true
::xowiki::includelet::html-file set personalized true

---