com.ibm.portal.content
Interface ModifiableRenderAspect

All Superinterfaces:

Identifiable, Modifiable, ModifiableIdentifiable, RenderAspect

All Known Subinterfaces:

ModifiableLayoutContainer, ModifiableLayoutControl, ModifiableLayoutNode

public interface ModifiableRenderAspect
extends RenderAspect, Modifiable, ModifiableIdentifiable

An interface representing modifiable render aspects.

Since:

6.1.0

Method Summary

boolean	confirmSetSkin(Skin skin) Indicates if the skin of the render aspect may be set.
boolean	confirmSetTemplateName(java.lang.String templateName) Indicates if the template name of the render aspect may be set.
Skin	setSkin(Skin skin) Sets the skin of the render aspect.
java.lang.String	setTemplateName(java.lang.String templateName) Sets the template name of the render aspect.

Methods inherited from interface com.ibm.portal.content.RenderAspect

getSkin, getTemplateName

Methods inherited from interface com.ibm.portal.ModifiableIdentifiable

getModifiableObjectID

Methods inherited from interface com.ibm.portal.Identifiable

getObjectID

Method Detail

setSkin

Skin setSkin(Skin skin)
             throws CannotModifyPropertyException

Sets the skin of the render aspect.

Parameters:

skin - the new skin for the render aspect. if a skin should be deleted specify null.

Returns:

the former skin; if none existed, null is returned

Throws:

CannotModifyPropertyException - in case the template name cannot be set

setTemplateName

java.lang.String setTemplateName(java.lang.String templateName)
                                 throws CannotModifyPropertyException

Sets the template name of the render aspect.

Parameters:

templateName - the name of the template, such as "Control" or "UnlayeredContainer", must not be null

Returns:

the formr template name; if none existed, null is returned

Throws:

CannotModifyPropertyException - in case the template name cannot be set

confirmSetSkin

boolean confirmSetSkin(Skin skin)
                       throws CannotModifyPropertyException

Indicates if the skin of the render aspect may be set.

Parameters:

skin - skin of render aspect for which to indicate if it may be set, may be null

Returns:

true in case the specified skin may be set, false otherwise

Throws:

CannotModifyPropertyException

confirmSetTemplateName

boolean confirmSetTemplateName(java.lang.String templateName)
                               throws CannotModifyPropertyException

Indicates if the template name of the render aspect may be set.

Parameters:

templateName - template name, such as "Control" or "UnlayeredContainer", for which to indicate if it may be set, must not be null

Returns:

true in case the specified template may be set, false otherwise

Throws:

CannotModifyPropertyException