Overview | Package | Class | Tree | Deprecated | Index | Help
| Copyright © 2006 BEA Systems, Inc. All Rights Reserved
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.bea.netuix.application.view
Interface MarkupView

All Superinterfaces
  Serializable

    public interface MarkupView

extends Serializable

View class for markup. Most resources in the portal framework have markup. Markup is a snippet of tokenized XML. Each resource has a begin XML and an end XML. Child resource's markup make up the markup between the begin and end. The tokens in the XML (example: $(title)) are replaced by values in the database colums when reassembled. Portal file markup is generally handled internally. There should be little need for portal developers to use the methods in this class.

"Views" are deep copy immutable objects. Unlike "Definitions" and "Instances" Views cannot be modified by the developer. An Instance or a Definition however can always be obtained from the view. The persistence APIs provide coarse grain and fine grain getters, but only fine grain setters. If you are interested in an object and all its children then retrieve the View, but if you are only interested in the immediate object and don't care about its children then retrieve the Definition.

See Also
  `View`
  This interface is intended to be implemented only by BEA Weblogic Portal.BEA Systems reserves the right to add abstract methods to this interface without notice. Implementations of this interface by other parties must not be expected to compile without change in future versions of BEA Weblogic Portal.

Field Summary
`static String` | `BOOK_TYPE` Constant for book markup.
`static String` | `DESKTOP_TYPE` Constant for desktop markup.
`static String` | `LAYOUT_TYPE` Constant for layout markup.
`static String` | `LOOK_AND_FEEL_TYPE` Constant for look-and-feel markup.
`static String` | `MENU_TYPE` Constant for menu markup.
`static String` | `PAGE_TYPE` Constant for page markup.
`static String` | `PLACEHOLDER_TYPE` Constant for placeholder markup.
`static String` | `PORTLET_TYPE` Constant for portlet markup.
`static String` | `SHELL_TYPE` Constant for shell markup.
`static String` | `THEME_TYPE` Constant for theme markup.

Method Summary
`String` | `getBeginXml()` Get the beginning XML fragment.
`String` | `getEndXml()` Get the end XML fragment.
`MarkupDefinition` | `getMarkupDefinition()` Retrieve the associated `MarkupDefinition` from this Markup View.
`MarkupDefinitionId` | `getMarkupDefinitionId()` Getter for markup definition id.
`String` | `getMarkupFile()` Get the name of the file where this markup lives.
`String` | `getName()` Getter for the unique markup name.
`String` | `getType()` The type of markup: Possible values: MarkupView.BOOK_TYPE MarkupView.PAGE_TYPE MarkupView.PLACEHOLDER_TYPE MarkupView.LAYOUT_TYPE MarkupView.PORTLET_TYPE MarkupView.SHELL_TYPE MarkupView.LOOK_AND_FEEL_TYPE MarkupView.THEME_TYPE MarkupView.DESKTOP_TYPE MarkupView.MENU_TYPE
`String` | `getWebAppName()` Return the name of the webapp that this markup is associated with.

Field Detail

### BOOK_TYPE

    static final String BOOK_TYPE

  Constant for book markup.

  See Also
    Constants Summary

### PAGE_TYPE

    static final String PAGE_TYPE

  Constant for page markup.

  See Also
    Constants Summary

### PLACEHOLDER_TYPE

    static final String PLACEHOLDER_TYPE

  Constant for placeholder markup.

  See Also
    Constants Summary

### LAYOUT_TYPE

    static final String LAYOUT_TYPE

  Constant for layout markup.

  See Also
    Constants Summary

### PORTLET_TYPE

    static final String PORTLET_TYPE

  Constant for portlet markup.

  See Also
    Constants Summary

### SHELL_TYPE

    static final String SHELL_TYPE

  Constant for shell markup.

  See Also
    Constants Summary

### LOOK_AND_FEEL_TYPE

    static final String LOOK_AND_FEEL_TYPE

  Constant for look-and-feel markup.

  See Also
    Constants Summary

### THEME_TYPE

    static final String THEME_TYPE

  Constant for theme markup.

  See Also
    Constants Summary

### DESKTOP_TYPE

    static final String DESKTOP_TYPE

  Constant for desktop markup.

  See Also
    Constants Summary

### MENU_TYPE

    static final String MENU_TYPE

  Constant for menu markup.

  See Also
    Constants Summary

Method Detail

### getMarkupDefinitionId

    MarkupDefinitionId getMarkupDefinitionId()

  Getter for markup definition id. The markup definition id is the primary key value for the definition in the PF_MARKUP_DEFINITION table.

  Returns
    a non-null unique definition id. This value should never be null as views are obtained via the persistence API.

### getMarkupDefinition

    MarkupDefinition getMarkupDefinition()

  Retrieve the associated `MarkupDefinition` from this Markup View. Markup Views are immutable but Definitions are not. Therefore it is often necessary to retrieve the definition from the view in order to update its values and then in turn call the persistence API. Most of the Markup Definitions (in the database) are constructed and updated via "dot" files. If you create a new "dot" file then a new Markup Definition is created in the database. If you edit the file the changes are automatically seen in the database (during dev time we poll the file system and in production we update the database whenever the webapp is redeployed).

  Returns
    a non-null Markup Definition

### getName

    String getName()

  Getter for the unique markup name. The markup name comes from the markupName attribute in the XML.

  Returns
    return the markup name.

### getType

    String getType()

  The type of markup: Possible values:
  - MarkupView.BOOK_TYPE
  - MarkupView.PAGE_TYPE
  - MarkupView.PLACEHOLDER_TYPE
  - MarkupView.LAYOUT_TYPE
  - MarkupView.PORTLET_TYPE
  - MarkupView.SHELL_TYPE
  - MarkupView.LOOK_AND_FEEL_TYPE
  - MarkupView.THEME_TYPE
  - MarkupView.DESKTOP_TYPE
  - MarkupView.MENU_TYPE

  Returns

### getWebAppName

    String getWebAppName()

  Return the name of the webapp that this markup is associated with. All resources in the portal framework database are scoped to the webapp.

  Returns
    a non-null webapp name.

### getMarkupFile

    String getMarkupFile()

  Get the name of the file where this markup lives. This may be null for resources that are not created from the dot files (example: cloned portlets, desktops, books and pages)

  Returns
    The filename, relative to the webapp or null if this resource was not created via a file.

### getBeginXml

    String getBeginXml()

  Get the beginning XML fragment. This is a tokenized string, so it might not be valid XML. The tokens will be populated by the assembler. The `beginXml` and `endXml` will prepend/append the XML for any children of the `View` that owns this `MarkupView`

### getEndXml

    String getEndXml()

  Get the end XML fragment. This is a tokenized string, so it might not be valid XML. The tokens will be populated by the assembler. The `beginXml` and `endXml` will prepend/append the XML for any children of the `View` that owns this `MarkupView`

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2006 BEA Systems, Inc. All Rights Reserved