framework reference

• global
• Application
• Request
• Response
• Session
• HopObject
• File
• FtpClient
• Image
• Mail
• Xml
• database connection
• database rowset
• mimepart
• skin

modules reference

• core.Array
• core.Date
• core.Number
• core.Object
• core.String


• helma.Aspects
• helma.Chart
• helma.Color
• helma.Database
• helma.File
• helma.Ftp
• helma.Html
• helma.Http
• helma.Mail
• helma.Search
• helma.Skin
• helma.Ssh
• helma.Url
• helma.Zip


• jala.AsyncRequest
• jala.BitTorrent
• jala.Captcha
• jala.Date
• jala.DnsClient
• jala.ErrorTracker
• jala.Form
• jala.History
• jala.HtmlDocument
• jala.I18n
• jala.ImageFilter
• jala.IndexManager
• jala.ListRenderer
• jala.Mp3Info
• jala.PodcastWriter
• jala.RemoteContent
• jala.Rss20Writer
• jala.Utilities
• jala.XmlRpcRequest
• jala.XmlWriter

skin

Object
   |
   +--skin

---

See:

- Packages.helma.framework.core.Skin
- global.createSkin

---

SUMMARY: Constructor | Properties | Methods

DETAIL: Constructor | Properties | Methods

---

Constructor Summary

skin(Object)             A Skin object that can be passed to the global functions renderSkin, resp.

 

Methods Summary
void	allowMacro(<String> macroname)            Limits the range of allowed macros to be rendered in a skin to an explicit set.
Boolean	containsMacro(<String> macroname)            Checks whether a skin does contain a specific macro.
String	getSource()            Returns the source of the unrendered skin.

Constructor Detail

skin

skin(Object)

A Skin object that can be passed to the global functions renderSkin, resp. renderSkinAsString.

Skins can either be defined by text files using a *.skin suffix, placed in an application's code repository or are created using the global createSkin function. There is no constructor to instantiate these objects.

See:
- Packages.helma.framework.core.Skin
- global.createSkin

---

Method Detail

allowMacro

void allowMacro(<String> macroname)

Limits the range of allowed macros to be rendered in a skin to an explicit set.

This is useful e.g. when text entered by non-trusted users is interpreted as skins to provide macro functions on a user-level.

Example:

 // Two macro functions defined in a JavaScript file:
  
function isAllowed_macro() {
   return("Hello");
 }
  
function isForbidden_macro() {
   return("World");
 }
  
 // The action that enables one of the macros:
  
function test_action() {
   var str = "<% root.isAllowed %>, <% root.isForbidden %>!";
   var skin = createSkin(str);
   // as soon as we call allowMacro() on a skin, only those
   // macros explicitely set are allowed to be evaluated.
   // all others will result in an error msg.
   skin.allowMacro("root.isAllowed");
   renderSkin(skin);
 }
  
 Hello, [Macro root.isForbidden not allowed in sandbox]!

Parameters:
macroname - as String

---

containsMacro

Boolean containsMacro(<String> macroname)

Checks whether a skin does contain a specific macro.

This is useful to make sure a user-edited skin does not contain any macro with which the application would break.



Example:

 var skin1 = createSkin("myMacro");
 var skin2 = createSkin("<% myMacro %>");
 var skin3 = createSkin("<% this.myMacro %>");
  
 res.writeln(skin1.containsMacro("myMacro"));
 false
  
 res.writeln(skin2.containsMacro("myMacro"));
 true
  
 res.writeln(skin3.containsMacro("myMacro"));
 false
  
 res.writeln(skin3.containsMacro("this.myMacro"));
 true

Parameters:
macroname - as String

Returns:
Boolean true if the skin contains the specified macro, otherwise false

---

getSource

String getSource()

Returns the source of the unrendered skin.

Returns:
String with the source of the unrendered skin

---

SUMMARY: Constructor | Properties | Methods

DETAIL: Constructor | Properties | Methods

---