LayoutDefinition Class

com.bea.netuix.application.definition
LayoutDefinition Class

public class LayoutDefinition

    extends Object
    implements Serializable

This class represents a persistant layout.

Hierarchy
Object
  LayoutDefinition
All Implemented Interfaces

Serializable

Constructor Summary
LayoutDefinition(LocalizationResource localizationResource, MarkupDefinitionId markupDefinitionId, PlaceholderDefinition placeholderDefinitions, String iconUri, String htmlLayoutUri, String webAppName, String layoutFile, boolean deleted)

Constructs a new LayoutDefinition object.
 

Method Summary
public String
getHtmlLayoutUri()
Getter for property htmlLayoutUri.
public String
getIconUri()
Getter for property iconUri.
public LayoutDefinitionId
getLayoutDefinitionId()
Returns the LayoutDefinitionId for this layout.
public String
getLayoutFile()
Returns the path to the layout file.
public LocalizationResource
getLocalizationResource()
Returns the LocalizationResource associated with this layout based on the locale of the request used for retrieving the layout.
public MarkupDefinitionId
getMarkupDefinitionId()
Returns the MarkupDefinitionId for the MarkupDefinition associated with this layout.
public PlaceholderDefinition
getPlaceholderDefinition(PlaceholderDefinitionId placeholderDefinitionId)
Returns a PlaceholderDefinition defined by this layout given the PlaceholderDefinitionId for the placeholder.
public PlaceholderDefinition[]
getPlaceholderDefinitions()
Returns the PlaceholderDefinitions defined by this layout.
public String
getWebAppName()
Returns the web application name this layout is scoped to.
public boolean
isDeleted()
Returns whether this layout has been deleted.
public void
setDeleted(boolean deleted)
Sets whether this layout has been deleted
public void
setHtmlLayoutUri(String htmlLayoutUri)
Setter for property htmlLayoutUri.
public void
setIconUri(String iconUri)
Setter for property iconUri.
public void
setLayoutFile(String layoutFile)
Sets the layout file path for this layout.
public void
setLocalizationResource(LocalizationResource localizationResource)
Sets the LocalizationResource for this layout.
public void
setMarkupDefinitionId(MarkupDefinitionId markupDefinitionId)
Sets the MarkupDefinitionId for this layout.
public void
setPlaceholderDefinitions(PlaceholderDefinition[] placeholderDefinitions)
Sets placeholer on this layout
public void
setWebAppName(String webAppName)
Scopes this layout to given web applcation.
public String
toString()
 
Methods from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
   

Constructor Detail

LayoutDefinition

public LayoutDefinition(LocalizationResource localizationResource, 
                        MarkupDefinitionId markupDefinitionId, 
                        PlaceholderDefinition[] placeholderDefinitions, 
                        String iconUri, 
                        String htmlLayoutUri, 
                        String webAppName, 
                        String layoutFile, 
                        boolean deleted)
Constructs a new LayoutDefinition object.
 

Method Detail

getHtmlLayoutUri() Method

public String getHtmlLayoutUri()
Getter for property htmlLayoutUri.

Returns

Value of property htmlLayoutUri.

getIconUri() Method

public String getIconUri()
Getter for property iconUri.

Returns

Value of property iconUri.

getLayoutDefinitionId() Method

public LayoutDefinitionId getLayoutDefinitionId()
Returns the LayoutDefinitionId for this layout. Returns NULL if this layout has not been retrieved using the persistence API.

Returns

LayoutDefinitionId

getLayoutFile() Method

public String getLayoutFile()
Returns the path to the layout file. This path is relative to the web application context.

Returns

layout file path

getLocalizationResource() Method

public LocalizationResource getLocalizationResource()
Returns the LocalizationResource associated with this layout based on the locale of the request used for retrieving the layout.

Returns

LocalizationResource associated with this layout

getMarkupDefinitionId() Method

public MarkupDefinitionId getMarkupDefinitionId()
Returns the MarkupDefinitionId for the MarkupDefinition associated with this layout.

Returns

MarkupDefinitionId

Related Topics

MarkupDefinition

getPlaceholderDefinition(PlaceholderDefinitionId) Method

public PlaceholderDefinition getPlaceholderDefinition(PlaceholderDefinitionId placeholderDefinitionId)
Returns a PlaceholderDefinition defined by this layout given the PlaceholderDefinitionId for the placeholder. Returns NULL if this layout defines no placeholders or the placeholder with given PlaceholderDefinitionId does not exist in this layout.

Parameters

placeholderDefinitionId
PlaceholderDefinitionId of placeholder to be retrieved

Returns

PlaceholderDefinitionId

getPlaceholderDefinitions() Method

public PlaceholderDefinition[] getPlaceholderDefinitions()
Returns the PlaceholderDefinitions defined by this layout.

Returns

PlaceholderDefinitions

getWebAppName() Method

public String getWebAppName()
Returns the web application name this layout is scoped to.

Returns

web application name

isDeleted() Method

public boolean isDeleted()
Returns whether this layout has been deleted.

Returns

true means this layout has been deleted

setDeleted(boolean) Method

public void setDeleted(boolean deleted)
Sets whether this layout has been deleted

setHtmlLayoutUri(String) Method

public void setHtmlLayoutUri(String htmlLayoutUri)
Setter for property htmlLayoutUri.

Parameters

htmlLayoutUri
New value of property htmlLayoutUri.

setIconUri(String) Method

public void setIconUri(String iconUri)
Setter for property iconUri.

Parameters

iconUri
New value of property iconUri.

setLayoutFile(String) Method

public void setLayoutFile(String layoutFile)
Sets the layout file path for this layout.

setLocalizationResource(LocalizationResource) Method

public void setLocalizationResource(LocalizationResource localizationResource)
Sets the LocalizationResource for this layout.

setMarkupDefinitionId(MarkupDefinitionId) Method

public void setMarkupDefinitionId(MarkupDefinitionId markupDefinitionId)
Sets the MarkupDefinitionId for this layout.

setPlaceholderDefinitions(PlaceholderDefinition[]) Method

public void setPlaceholderDefinitions(PlaceholderDefinition[] placeholderDefinitions)
Sets placeholer on this layout

Parameters

placeholderDefinitions
PlaceholderDefinitions to be set on this layout

setWebAppName(String) Method

public void setWebAppName(String webAppName)
Scopes this layout to given web applcation.

toString() Method

public String toString()
Overrides
Object.toString()