ClientSideLayouts
extends Object| java.lang.Object | |
| ↳ | com.microstrategy.utils.config.ClientSideLayouts |
Class Overview
This class provides the front-end from retrieving client-side layout contents for use with the Javascript UI Library (JUIL). It interacts with server-side caches to reduce the number of file accesses. In this respect, it is merely a helper class for client-side layouts.
Summary
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| String | BLOCK_PROPERTY_LAYOUT_CLASS_NAME | The name of the Block Property that we will scan for layout classes. | |||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| ClientSideLayouts() | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| static String |
getLayoutClassName(String layoutClass)
Returns the layout class name without the plugin macro.
| ||||||||||
| static String |
getLayoutStatement(String layoutClass)
Returns a JavaScript statement which defines the layout for a
given layout class.
| ||||||||||
| static void |
getLayoutStatementsFromBlock(MarkupOutput out, Block block, String propName)
Get an entire set of JavaScript layout statements by scanning a
Block tree for all layout classes that are defined in a specific named
Block Property.
| ||||||||||
| static void |
getLayoutStatementsFromBlock(MarkupOutput out, Block block)
Get an entire set of JavaScript layout statements by scanning a
Block tree for all layout classes that are defined in a specific named
Block Property.
| ||||||||||
| static String |
getPlugin(String layoutClass)
Returns the plugin macro contained in the layout class property.
| ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Constants
public static final String BLOCK_PROPERTY_LAYOUT_CLASS_NAME
The name of the Block Property that we will scan for layout classes.
Public Constructors
public ClientSideLayouts ()
Public Methods
public static String getLayoutClassName (String layoutClass)
Returns the layout class name without the plugin macro.
Parameters
| layoutClass | The layout class property value for the block. It may contains a plugin macro, such as "@plugin1:". |
|---|
Returns
- the layout class name without the plugin macro.
public static String getLayoutStatement (String layoutClass)
Returns a JavaScript statement which defines the layout for a given layout class.
Parameters
| layoutClass | The name of the layout class to retrieve. |
|---|
Returns
- A JavaScript statement that assigns to the layout class the
textual declaration of the layout. If the layout class does not
exist or is malformed, then
nullis returned.
public static void getLayoutStatementsFromBlock (MarkupOutput out, Block block, String propName)
Get an entire set of JavaScript layout statements by scanning a Block tree for all layout classes that are defined in a specific named Block Property.
Parameters
| out | The MarkupOutput to generate the JavaScript
statements into. |
|---|---|
| block | The Block instance to scan for layout classes
referenced in a BlockProperty value. |
| propName | The name of the BlockProperty to inspect for
layout class names.
|
public static void getLayoutStatementsFromBlock (MarkupOutput out, Block block)
Get an entire set of JavaScript layout statements by scanning a
Block tree for all layout classes that are defined in a specific named
Block Property. The name of the Block Property to inspect is defined in
BLOCK_PROPERTY_LAYOUT_CLASS_NAME.
Parameters
| out | The MarkupOutput to generate the JavaScript
statements into. |
|---|---|
| block | The Block instance to scan for layout classes
referenced in a BlockProperty value. |
public static String getPlugin (String layoutClass)
Returns the plugin macro contained in the layout class property.
Parameters
| layoutClass | The layout class property value for the block. It may contains a plugin macro, such as "@plugin1:". |
|---|
Returns
- the plugin macro, such as "@plugin1:".