com.ibm.mashups.enabler
Interface EmbeddingGenerator


public EmbeddingGenerator

This class allows to generate single line script include for the embedding feature


Field Summary
 unknown widgetDefinition
           
 unknown pid
           
 unknown width
           
 unknown height
           
 unknown scrollbar
           
 unknown sandboxed
           
 unknown framework
           
 unknown preferences
           
 
Constructor Summary
constructor(String widgetDef, String pid)
           This is the constructor for EmbeddingGenerator, which allows to instantiate the EmbeddingGenerator with the default settings for widget / page embedding.
 
Method Summary
 unknown _getSecureHostAlias()
           This method will get a hostname, in sandboxed mode it will be a magic host name.
 unknown toString()
           Creates the single script include with the current attribute settings of this class.
 String getWidgetDefinition()
           gets the current widget definition path for this embedding generator.
 unknown setWidgetDefinition(String value)
           sets the current widget definition path for this embedding generator
 String getPid()
           gets the current page id for this embedding generator.
 unknown setPid(String value)
           sets the pid for this embedding generator
 int getWidth()
           gets the current width for this embedding generator.
 unknown setWidth(int value)
           sets the current width for this embedding generator
 int getHeight()
           gets the current height for this embedding generator.
 unknown setHeight(int value)
           sets the current height for this embedding generator
 boolean getScrollbar()
           gets the current state of scrollbar for this embedding generator.
 unknown setScrollbar(boolean value)
           sets whether the scrollbar should be enabled or not
 boolean getSandboxed()
           gets whether the widget should be sandboxed or not
 unknown setSandboxed(boolean value)
           sets whether the widget should be sandboxed
 String getFramework()
           gets the current framework typefor this embedding generator.
 unknown setFramework(String value)
           sets the current framework for this embedding generator
 ItemSet getPreferences()
           gets the current framework typefor this embedding generator.
 unknown setPreferences(ItemSet value)
           sets the preferences for this embedding generator
 

Field Detail

widgetDefinition

unknown widgetDefinition

pid

unknown pid

width

unknown width

height

unknown height

scrollbar

unknown scrollbar

sandboxed

unknown sandboxed

framework

unknown framework

preferences

unknown preferences
Constructor Detail

constructor

public constructor(String widgetDef,
                   String pid)
This is the constructor for EmbeddingGenerator, which allows to instantiate the EmbeddingGenerator with the default settings for widget / page embedding.

Parameters:
widgetDef - the path to the widget definition (either absolute or relative to the embedding server). In case of page embedding widgetDef points to the layout widget to use for page embedding
pid - the page ID of the page to include. If only widget embedding is needed, this parameter can be left empty.
Method Detail

_getSecureHostAlias

unknown _getSecureHostAlias()
This method will get a hostname, in sandboxed mode it will be a magic host name. NOTE: the host name is the same for the lifetime of this object.


toString

unknown toString()
Creates the single script include with the current attribute settings of this class.


getWidgetDefinition

String getWidgetDefinition()
gets the current widget definition path for this embedding generator.


setWidgetDefinition

unknown setWidgetDefinition(String value)
sets the current widget definition path for this embedding generator

Parameters:
value - the widget definition url

getPid

String getPid()
gets the current page id for this embedding generator.


setPid

unknown setPid(String value)
sets the pid for this embedding generator

Parameters:
value - the pid

getWidth

int getWidth()
gets the current width for this embedding generator.


setWidth

unknown setWidth(int value)
sets the current width for this embedding generator

Parameters:
value - the width

getHeight

int getHeight()
gets the current height for this embedding generator.


setHeight

unknown setHeight(int value)
sets the current height for this embedding generator

Parameters:
value - the height

getScrollbar

boolean getScrollbar()
gets the current state of scrollbar for this embedding generator.


setScrollbar

unknown setScrollbar(boolean value)
sets whether the scrollbar should be enabled or not

Parameters:
value - true when the scrollbar should be enabled, default: false

getSandboxed

boolean getSandboxed()
gets whether the widget should be sandboxed or not


setSandboxed

unknown setSandboxed(boolean value)
sets whether the widget should be sandboxed

Parameters:
value - true when the widget should be sandboxed, default: false

getFramework

String getFramework()
gets the current framework typefor this embedding generator.


setFramework

unknown setFramework(String value)
sets the current framework for this embedding generator

Parameters:
value - the framework to use for the widget (not used in page mode), default: to false

getPreferences

ItemSet getPreferences()
gets the current framework typefor this embedding generator.


setPreferences

unknown setPreferences(ItemSet value)
sets the preferences for this embedding generator

Parameters:
value - the preferences


Copyright IBM Corp. 2010 All Rights Reserved.