Package helma.framework.core
Class Skin
java.lang.Object
helma.framework.core.Skin
This represents a Helma skin, i.e. a template created from containing Macro tags
that will be dynamically evaluated.. It uses the request path array
from the RequestEvaluator object to resolve Macro handlers by type name.
-
Nested Class Summary
Nested Classes -
Constructor Summary
ConstructorsConstructorDescriptionSkin
(char[] content, int length, Application app) Create a skin without any restrictions on the macros from a char array.Skin
(String content, Application app) Create a skin without any restrictions on which macros are allowed to be called from itSkin
(String content, Application app, HashSet sandbox) Create a skin with a sandbox which contains the names of macros allowed to be called -
Method Summary
Modifier and TypeMethodDescriptionvoid
allowMacro
(String macroname) Adds a macro to the list of allowed macros.boolean
containsMacro
(String macroname) Check if a certain macro is present in this skin.Return the list of macros found by the parserstatic Skin
getSkin
(Resource res, Application app) Get the raw source text this skin was parsed fromgetSubskin
(String name) Get a subskin by nameString[]
Return an array of subskin names defined in this skinboolean
Check if this skin has a main skin, as opposed to consisting just of subskinsboolean
hasSubskin
(String name) Check if this skin contains a subskin with the given namevoid
render
(RequestEvaluator reval, Object thisObject, Object paramObject) Render this skinrenderAsString
(RequestEvaluator reval, Object thisObject, Object paramObject) Render this skin and return it as string
-
Constructor Details
-
Skin
Create a skin without any restrictions on which macros are allowed to be called from it -
Skin
Create a skin with a sandbox which contains the names of macros allowed to be called -
Skin
Create a skin without any restrictions on the macros from a char array.
-
-
Method Details
-
getSkin
- Throws:
IOException
-
getMacros
Return the list of macros found by the parser- Returns:
- the list of macros
-
hasMainskin
public boolean hasMainskin()Check if this skin has a main skin, as opposed to consisting just of subskins- Returns:
- true if this skin contains a main skin
-
hasSubskin
Check if this skin contains a subskin with the given name- Parameters:
name
- a subskin name- Returns:
- true if the given subskin exists
-
getSubskin
Get a subskin by name- Parameters:
name
- the subskin name- Returns:
- the subskin
-
getSubskinNames
Return an array of subskin names defined in this skin- Returns:
- a string array containing this skin's substrings
-
getExtends
-
getSource
Get the raw source text this skin was parsed from -
renderAsString
public String renderAsString(RequestEvaluator reval, Object thisObject, Object paramObject) throws RedirectException, UnsupportedEncodingException Render this skin and return it as string -
render
public void render(RequestEvaluator reval, Object thisObject, Object paramObject) throws RedirectException, UnsupportedEncodingException Render this skin -
containsMacro
Check if a certain macro is present in this skin. The macro name is in handler.name notation -
allowMacro
Adds a macro to the list of allowed macros. The macro is in handler.name notation.
-