com.ibm.mashups.enabler.runtime.skin
Interface RuntimeSkinModel

All Superinterfaces:
Invalidatable, ListModel, Locator, Model, RuntimeSkinLocator

public RuntimeSkinModel
extends ListModel, RuntimeSkinLocator, Invalidatable

Interface for a runtime skin model.

Note: Using Strategies is not supported

Since:
2.4

Method Summary
 Integer addStyleFilter(Integer ordinal, StyleFilter filter, LayoutNode scopeObject)
           Adds a Style Filter to this runtime skin model
 void removeStyleFilter(String filterId)
           Removes a Style filter for this runtime skin model.
 ModifiableRuntimeSkinNode find(String id)
           Returns the runtime skin for the specified layout node ID
 
Methods inherited from interface com.ibm.mashups.enabler.ListModel
iterator
 
Methods inherited from interface com.ibm.mashups.enabler.model.Model
setStrategy, getStrategies, getStrategy, addStrategy, removeStrategy
 
Methods inherited from interface com.ibm.mashups.enabler.Locator
find
 
Methods inherited from interface com.ibm.mashups.enabler.runtime.skin.RuntimeSkinLocator
findByLayoutNode
 
Methods inherited from interface com.ibm.mashups.enabler.Locator
find
 
Methods inherited from interface com.ibm.mashups.enabler.Invalidatable
invalidate
 

Method Detail

addStyleFilter

Integer addStyleFilter(Integer ordinal,
                       StyleFilter filter,
                       LayoutNode scopeObject)
Adds a Style Filter to this runtime skin model

Parameters:
ordinal - postion to add the filter. Possible values are 0 - 50000. greater than or equal to 0 will place the filter at the beginning of the chain, while greater than or equal to 50000 will add it to the end of the chain. If a registered filter already has the same ordinal, then the filter to be added will be inserted directly after the registered filter with the same ordinal. See  Constants for ordinal constants for the first and last positions.
filter - filter object, must not be null
scopeObject - LayoutNode object used to scope the RuntimeSkinNodes that a filter will operate on. If null, then the filter will operate on all RuntimeSkinNode Style changes. If it is an instance of  LayoutControl , then the listener will only operate on RuntimeSkinNode Style changes for the specified LayoutControl. If it is an instance of  LayoutContainer , then the filter will operate on any RuntimeSkinNodes that represent the LayoutContainer's child LayoutControls.
Returns:
return filter id if the filter is registered successfully, null otherwise

removeStyleFilter

void removeStyleFilter(String filterId)
Removes a Style filter for this runtime skin model.

Parameters:
filterId - ID of the filter to be removed, must not be null

find

ModifiableRuntimeSkinNode find(String id)
Returns the runtime skin for the specified layout node ID

Parameters:
id - the ID of the LayoutNode object used to find the RuntimeSkinNode. Must not be null.
Returns:
runtime skin node for this LayoutNode, or null if LayoutNode does not exist. Will also return null if the specified Layout Node is not active (ie, not on the current page)
See Also:
ModifiableRuntimeSkinNode


Copyright IBM Corp. 2010 All Rights Reserved.