org.bladerunnerjs.api

Interface BrowsableNode

All Superinterfaces:

org.bladerunnerjs.model.AssetContainer, BRJSNode, BundlableNode, org.bladerunnerjs.model.engine.Node

All Known Implementing Classes:

org.bladerunnerjs.model.AbstractBrowsableNode, Aspect, BladesetWorkbench, BladeWorkbench, Workbench

public interface BrowsableNode
extends BundlableNode

A BrowsableNode is a location that contains an index page, which would be a Aspect, BladeWorkbench or BladesetWorkbench.

Method Summary

Modifier and Type	Method and Description
void	filterIndexPage(java.lang.String indexPage, Locale locale, java.lang.String version, java.io.Writer writer, org.bladerunnerjs.model.RequestMode requestMode) The method replaces the tag handlers from your index pages with the appropriate content as indicated, such as the required CSS bundle, for example.

Methods inherited from interface org.bladerunnerjs.api.BundlableNode

assets, getBundleSet, getLinkedAsset, handleLogicalRequest, handleLogicalRequest, seedAssets

Methods inherited from interface org.bladerunnerjs.model.AssetContainer

app, asset, assets, canonicaliseRequirePath, isNamespaceEnforced, requirePrefix, scopeAssetContainers

Methods inherited from interface org.bladerunnerjs.api.BRJSNode

addTemplateTransformations, getTemplateName, populate

Methods inherited from interface org.bladerunnerjs.model.engine.Node

addObserver, addObserver, containsFile, create, delete, dir, dirExists, discoverAllChildren, exists, file, getObservers, getTypeName, incrementChildFileVersions, incrementFileVersion, memoizedScopeFiles, nodeProperties, notifyObservers, parentNode, ready, storageDir, storageFile

Method Detail

filterIndexPage

void filterIndexPage(java.lang.String indexPage,
                     Locale locale,
                     java.lang.String version,
                     java.io.Writer writer,
                     org.bladerunnerjs.model.RequestMode requestMode)
              throws ModelOperationException

The method replaces the tag handlers from your index pages with the appropriate content as indicated, such as the required CSS bundle, for example.

Parameters:

indexPage - a String object representing the content of the index page

locale - a Locale object representing the locale used

version - a String object representing the version used

writer - a Writer object used as a stream for the newly updated content

requestMode - a RequestMode object showing whether the request is made in DEV (development) or PROD (production) mode

Throws:

ModelOperationException - if any exceptions are thrown when performing the filter