com.ibm.portal.admin
Interface MarkupCapable

All Known Subinterfaces:

ContentLabel, ContentNode, ContentPage, ContentURL, ExternalContentURL, InternalContentURL, LayoutControl, ModifiableContentLabel, ModifiableContentNode, ModifiableContentPage, ModifiableContentURL, ModifiableExternalContentURL, ModifiableInternalContentURL, ModifiableLayoutControl, ModifiableMarkupCapable, ModifiablePortlet, ModifiablePortletDefinition, ModifiableSkin, ModifiableStaticContentPage, ModifiableTheme, Portlet, PortletDefinition, Skin, StaticContentPage, Theme

public interface MarkupCapable

This interface describes markup-capable nodes. These are nodes that can be assigned with markups.

Since:

5.1.0.1

Method Summary

ListModel<java.lang.String>	getMarkups() Returns a ListModel object of String objects that are contained in the object's list of supported markups.
boolean	supportsMarkup(Markup aMarkup) Checks if a given markup is in the list of supported markups. This method checks if the markup capable element may be displayed in the given markup.
boolean	supportsMarkup(java.lang.String aMarkup) Checks if a given markup is in the list of supported markups. This method checks if the markup capable element may be displayed in the given markup.

Method Detail

getMarkups

ListModel<java.lang.String> getMarkups()
                                       throws ModelException,
                                              DataException

Returns a ListModel object of String objects that are contained in the object's list of supported markups.

Returns:

a list model of String objects which denote the markups that the element supports, never null

Throws:

DataException - if an error occured while accessing the database

ModelException - if an error occured while accessing model information

supportsMarkup

boolean supportsMarkup(java.lang.String aMarkup)
                       throws ModelException

Checks if a given markup is in the list of supported markups.
This method checks if the markup capable element may be displayed in the given markup.

Parameters:

aMarkup - The markup that is to be checked.

Returns:

true if the markup is in the list of supported markups, false if not.

Throws:

ModelException - if an error occured while accessing model information

supportsMarkup

boolean supportsMarkup(Markup aMarkup)
                       throws ModelException

Checks if a given markup is in the list of supported markups.
This method checks if the markup capable element may be displayed in the given markup.

Parameters:

aMarkup - The markup that is to be checked.

Returns:

true, if the markup is in the list of supported markups, false otherwise.

Throws:

ModelException - if an error occured while accessing model information