Interface Layout

All Superinterfaces:
AttachedModel, AuditedModel, BaseModel<Layout>, ClassedModel, Cloneable, Comparable<Layout>, CTModel<Layout>, ExternalReferenceCodeModel, GroupedModel, LayoutModel, LocalizedModel, MVCCModel, PersistedModel, Serializable, ShardedModel, StagedGroupedModel, StagedModel, TypedModel, WorkflowedModel
All Known Implementing Classes:
LayoutWrapper, VirtualLayout

@ProviderType public interface Layout extends LayoutModel, PersistedModel
The extended model interface for the Layout service. Represents a row in the "Layout" database table, with each column mapped to a property of this class.
Author:
Brian Wing Shun Chan
See Also:
{$generated.description}
  • Field Details

  • Method Details

    • fetchDraftLayout

      Layout fetchDraftLayout()
    • getAllChildren

      List<Layout> getAllChildren()
      Returns all layouts that are direct or indirect children of the current layout.
      Returns:
      the layouts that are direct or indirect children of the current layout
    • getAncestorLayoutId

      long getAncestorLayoutId() throws PortalException
      Returns the ID of the topmost parent layout (e.g. n-th parent layout) of the current layout.
      Returns:
      the ID of the topmost parent layout of the current layout
      Throws:
      PortalException
    • getAncestorPlid

      long getAncestorPlid() throws PortalException
      Returns the plid of the topmost parent layout (e.g. n-th parent layout) of the current layout.
      Returns:
      the plid of the topmost parent layout of the current layout
      Throws:
      PortalException
    • getAncestors

      List<Layout> getAncestors() throws PortalException
      Returns all parent layouts of the current layout. The list is retrieved recursively with the direct parent layout listed first, and most distant parent listed last.
      Returns:
      the current layout's list of parent layouts
      Throws:
      PortalException
    • getBreadcrumb

      String getBreadcrumb(Locale locale) throws PortalException
      Throws:
      PortalException
    • getChildren

      List<Layout> getChildren()
      Returns all child layouts of the current layout, independent of user access permissions.
      Returns:
      the list of all child layouts
    • getChildren

      List<Layout> getChildren(PermissionChecker permissionChecker) throws PortalException
      Returns all child layouts of the current layout that the user has permission to access.
      Parameters:
      permissionChecker - the user-specific context to check permissions
      Returns:
      the list of all child layouts that the user has permission to access
      Throws:
      PortalException
    • getColorScheme

      ColorScheme getColorScheme() throws PortalException
      Returns the color scheme that is configured for the current layout, or the color scheme of the layout set that contains the current layout if no color scheme is configured.
      Returns:
      the color scheme that is configured for the current layout, or the color scheme of the layout set that contains the current layout if no color scheme is configured
      Throws:
      PortalException
    • getCssText

      String getCssText() throws PortalException
      Returns the CSS text for the current layout, or for the layout set if no CSS text is configured in the current layout.

      Layouts and layout sets can configure CSS that is applied in addition to the theme's CSS.

      Returns:
      the CSS text for the current layout, or for the layout set if no CSS text is configured in the current layout
      Throws:
      PortalException
    • getDefaultThemeSetting

      String getDefaultThemeSetting(String key, String device, boolean inheritLookAndFeel)
    • getEmbeddedPortlets

      List<Portlet> getEmbeddedPortlets()
    • getEmbeddedPortlets

      List<Portlet> getEmbeddedPortlets(long groupId)
    • getFaviconURL

      String getFaviconURL()
    • getFriendlyURL

      String getFriendlyURL(Locale locale)
      Returns the layout's friendly URL for the given locale.
      Parameters:
      locale - the locale that the friendly URL should be retrieved for
      Returns:
      the layout's friendly URL for the given locale
    • getFriendlyURLMap

      Map<Locale,String> getFriendlyURLMap()
      Returns the friendly URLs for all configured locales.
      Returns:
      the friendly URLs for all configured locales
    • getFriendlyURLsXML

      String getFriendlyURLsXML()
    • getGroup

      Group getGroup()
      Returns the current layout's group.

      Group is Liferay's technical name for a site.

      Returns:
      the current layout's group
    • getHTMLTitle

      String getHTMLTitle(Locale locale)
      Returns the current layout's HTML title for the given locale, or the current layout's name for the given locale if no HTML title is configured.
      Parameters:
      locale - the locale that the HTML title should be retrieved for
      Returns:
      the current layout's HTML title for the given locale, or the current layout's name for the given locale if no HTML title is configured
    • getHTMLTitle

      String getHTMLTitle(String localeLanguageId)
      Returns the current layout's HTML title for the given locale language ID, or the current layout's name if no HTML title is configured.
      Parameters:
      localeLanguageId - the locale that the HTML title should be retrieved for
      Returns:
      the current layout's HTML title for the given locale language ID, or the current layout's name if no HTML title is configured
    • getIcon

      String getIcon()
    • getIconImage

      boolean getIconImage()
      Returns true if the current layout has a configured icon.
      Returns:
      true if the current layout has a configured icon; false otherwise
    • getLayoutSet

      LayoutSet getLayoutSet()
      Returns the current layout's LayoutSet.
      Returns:
      the current layout's layout set
    • getLayoutSetPrototypeLayout

      Layout getLayoutSetPrototypeLayout()
    • getLayoutType

      LayoutType getLayoutType()
      Returns the current layout's LayoutType.
      Returns:
      the current layout's layout type
    • getLinkedToLayout

      Layout getLinkedToLayout()
      Returns the current layout's linked layout.
      Returns:
      the current layout's linked layout, or null if no linked layout could be found
    • getRegularURL

      String getRegularURL(javax.servlet.http.HttpServletRequest httpServletRequest) throws PortalException
      Throws:
      PortalException
    • getResetLayoutURL

      String getResetLayoutURL(javax.servlet.http.HttpServletRequest httpServletRequest) throws PortalException
      Throws:
      PortalException
    • getResetMaxStateURL

      String getResetMaxStateURL(javax.servlet.http.HttpServletRequest httpServletRequest) throws PortalException
      Throws:
      PortalException
    • getScopeGroup

      Group getScopeGroup() throws PortalException
      Throws:
      PortalException
    • getTarget

      String getTarget()
    • getTheme

      Theme getTheme() throws PortalException
      Returns the current layout's theme, or the layout set's theme if no layout theme is configured.
      Returns:
      the current layout's theme, or the layout set's theme if no layout theme is configured
      Throws:
      PortalException
    • getThemeSetting

      String getThemeSetting(String key, String device)
    • getThemeSetting

      String getThemeSetting(String key, String device, boolean inheritLookAndFeel)
    • getTypeSettingsProperties

      UnicodeProperties getTypeSettingsProperties()
    • getTypeSettingsProperty

      String getTypeSettingsProperty(String key)
    • getTypeSettingsProperty

      String getTypeSettingsProperty(String key, String defaultValue)
    • hasAncestor

      boolean hasAncestor(long layoutId) throws PortalException
      Returns true if the given layout ID matches one of the current layout's hierarchical parents.
      Parameters:
      layoutId - the layout ID to search for in the current layout's parent list
      Returns:
      true if the given layout ID matches one of the current layout's hierarchical parents; false otherwise
      Throws:
      PortalException
    • hasChildren

      boolean hasChildren()
      Returns true if the current layout has child layouts.
      Returns:
      true if the current layout has child layouts, false otherwise
    • hasScopeGroup

      boolean hasScopeGroup() throws PortalException
      Throws:
      PortalException
    • hasSetModifiedDate

      boolean hasSetModifiedDate()
    • includeLayoutContent

      boolean includeLayoutContent(javax.servlet.http.HttpServletRequest httpServletRequest, javax.servlet.http.HttpServletResponse httpServletResponse) throws Exception
      Throws:
      Exception
    • isChildSelected

      boolean isChildSelected(boolean selectable, Layout layout) throws PortalException
      Throws:
      PortalException
    • isContentDisplayPage

      boolean isContentDisplayPage()
      Returns true if the current layout can be used as a content display page.

      A content display page must have an Asset Publisher portlet that is configured as the default Asset Publisher for the layout.

      Returns:
      true if the current layout can be used as a content display page; false otherwise
    • isCustomizable

      boolean isCustomizable()
    • isDraftLayout

      boolean isDraftLayout()
    • isEmbeddedPersonalApplication

      boolean isEmbeddedPersonalApplication()
    • isFirstChild

      boolean isFirstChild()
      Returns true if the current layout is the first layout in its parent's hierarchical list of children layouts.
      Returns:
      true if the current layout is the first layout in its parent's hierarchical list of children layouts; false otherwise
    • isFirstParent

      boolean isFirstParent()
      Returns true if the current layout is the topmost parent layout.
      Returns:
      true if the current layout is the topmost parent layout; false otherwise
    • isIconImage

      boolean isIconImage()
    • isInheritLookAndFeel

      boolean isInheritLookAndFeel()
      Returns true if the current layout utilizes its LayoutSet's look and feel options (e.g. theme and color scheme).
      Returns:
      true if the current layout utilizes its layout set's look and feel options; false otherwise
    • isLayoutDeleteable

      boolean isLayoutDeleteable()
    • isLayoutPrototypeLinkActive

      boolean isLayoutPrototypeLinkActive()
      Returns true if the current layout is built from a layout template and still maintains an active connection to it.
      Returns:
      true if the current layout is built from a layout template and still maintains an active connection to it; false otherwise
    • isLayoutSortable

      boolean isLayoutSortable()
    • isLayoutUpdateable

      boolean isLayoutUpdateable()
    • isPortletEmbedded

      boolean isPortletEmbedded(String portletId, long groupId)
    • isPublicLayout

      boolean isPublicLayout()
      Returns true if the current layout is part of the public LayoutSet.

      Note, the returned value reflects the layout's default access options, not its access permissions.

      Returns:
      true if the current layout is part of the public layout set; false otherwise
    • isPublished

      boolean isPublished()
    • isRootLayout

      boolean isRootLayout()
      Returns true if the current layout is the root layout.
      Returns:
      true if the current layout is the root layout; false otherwise
    • isSelected

      boolean isSelected(boolean selectable, Layout layout, long ancestorPlid)
    • isSupportsEmbeddedPortlets

      boolean isSupportsEmbeddedPortlets()
      Returns true if the current layout can hold embedded portlets.
      Returns:
      true if the current layout can hold embedded portlets; false otherwise
    • isTypeAssetDisplay

      boolean isTypeAssetDisplay()
    • isTypeContent

      boolean isTypeContent()
    • isTypeControlPanel

      boolean isTypeControlPanel()
    • isTypeEmbedded

      boolean isTypeEmbedded()
    • isTypeLinkToLayout

      boolean isTypeLinkToLayout()
    • isTypePanel

      boolean isTypePanel()
    • isTypePortlet

      boolean isTypePortlet()
    • isTypeURL

      boolean isTypeURL()
    • isTypeUtility

      boolean isTypeUtility()
    • isUnlocked

      boolean isUnlocked(String mode, long userId)
    • matches

      boolean matches(javax.servlet.http.HttpServletRequest httpServletRequest, String friendlyURL)
    • setLayoutSet

      void setLayoutSet(LayoutSet layoutSet)
    • setTypeSettingsProperties

      void setTypeSettingsProperties(UnicodeProperties typeSettingsUnicodeProperties)