|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
com.bea.netuix.servlets.controls.ControlContext
com.bea.netuix.servlets.controls.PresentationContext
com.bea.netuix.servlets.controls.window.WindowPresentationContext
public abstract class WindowPresentationContext
This class represents a portal window component. All presentation-related attributes of a window component are available from instances of this class. Such instances are typically used during portal rendering via look and feel skeleton files (e.g. window.jsp).
getWindowPresentationContext(javax.servlet.http.HttpServletRequest)
, Serialized FormField Summary | |
---|---|
protected static String |
CLASS_NAME |
Method Summary | |
---|---|
Capability |
getCapability(Capability capability) Gets the capability for the Window, may be a state or a mode. |
ContentAttributeRenderer |
getContentAttributeRenderer() Returns a renderer for this window's content attributes. |
String |
getContentPresentationClass() Returns this window's content presentationClass attribute. |
List |
getContentPresentationContextChildren() Returns a list of PresentationContext children within this window's content area. |
String |
getContentPresentationStyle() Returns this window's content presentationStyle attribute. |
String |
getDefinitionId() The definition id for the window. |
String |
getDefinitionLabel() The definition label for the window. |
String |
getInstanceId() Returns the instance id for the window. |
abstract String |
getLabel() Returns a general label for the window. |
String |
getLocalInstanceId() Returns the Local () instance id for the window. |
MetaData |
getMetaData(String name) Return the metadata elements for this control matching the supplied name |
MetaData[] |
getMetaDatas() Return the metadata elements for this control |
String |
getOrientation() Returns the orientation of the window's navigation/titlebar. |
PagePresentationContext |
getParentPagePresentationContext() If this window is a child of a page, that page's PagePresentationContext is returned. |
WindowMode |
getPreviousWindowMode() Returns the previous mode of the window, which may be from the standard set or an extended mode. |
ThemePresentationContext |
getThemePresentationContext() Returns a ThemePresentation context for this portlet, page or book if one has been applied. |
String |
getTitle() Returns the display title for the window, which may be localized if a proper localizable value can be resolved. |
TitlebarPresentationContext |
getTitlebarPresentationContext() Returns a TitlebarPresentation context for this portlet, page or book if one exists. |
WindowMode |
getWindowMode() Returns the current mode of the window, which may be from the standard set or an extended mode. |
static WindowPresentationContext |
getWindowPresentationContext(javax.servlet.http.HttpServletRequest request) This is a convenience method for returning a reference to the current WindowPresentationContext . |
WindowState |
getWindowState() Returns the current state of the window, which may be from the following fixed set: normal, minimized, maximized. |
boolean |
isCapable(Capability capability) Returns true if this control has the specified capability. |
boolean |
isPacked() Returns whether or not the window should be rendered such that it occupies a minimal space as required by its contents (packed), or tries to expand to the maximum size of its containing layout cell. |
Methods inherited from class com.bea.netuix.servlets.controls.PresentationContext |
---|
addCookie, addDateHeader, addHeader, addIntHeader, getAttributeRenderer, getChildren, getChildren, getFirstChild, getOrderedChildren, getParsedProperties, getPresentationClass, getPresentationId, getPresentationStyle, getProperties, getProperty, getProperty, getPropertyAsBoolean, getPropertyAsInt, getRenderFormat, getResolvedLocale, getTagName, isVisible, setCharacterEncoding, setContentType, setVisible |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final String CLASS_NAME
Method Detail |
---|
public WindowMode getWindowMode()
WindowMode
public WindowMode getPreviousWindowMode()
WindowMode
public WindowState getWindowState()
WindowState
public String getTitle()
public String getInstanceId()
getLocalInstanceId()
public String getLocalInstanceId()
getInstanceId()
public String getDefinitionId()
public String getOrientation()
public boolean isPacked()
public String getDefinitionLabel()
public ContentAttributeRenderer getContentAttributeRenderer()
public abstract String getLabel()
public List getContentPresentationContextChildren()
PresentationContext
children within this window's content area.public PagePresentationContext getParentPagePresentationContext()
PagePresentationContext
is returned.public String getContentPresentationClass()
PresentationContext.getPresentationClass()
public String getContentPresentationStyle()
PresentationContext.getPresentationStyle()
public boolean isCapable(Capability capability)
true
if this control has the specified capability.capability
- A window mode or stateWindowCapabilities
public Capability getCapability(Capability capability) throws NullPointerException
Gets the capability for the Window, may be a state or a mode. This method can be used to check if a Window (Book, Page or Portlet) supports a given Mode or State. If you are intersted in the current or active Window Mode or Window State you should use getWindowMode()
and getWindowState
repectively.
Note: this method should be called after the init()
lifcycle, because the buttons have net yet registered with the parent window.
capability
- the Capability
to check for.NullPointerException
WindowCapabilities
, Capability
, WindowMode
, WindowState
public ThemePresentationContext getThemePresentationContext()
public TitlebarPresentationContext getTitlebarPresentationContext()
public MetaData[] getMetaDatas()
MetaData<code/> objects
public MetaData getMetaData(String name)
public static WindowPresentationContext getWindowPresentationContext(javax.servlet.http.HttpServletRequest request)
WindowPresentationContext
. Note this method will only work if called from within a portal (typically, from the window.jsp skeleton). This method may return null if called when no appropriate context exists, but such a context should safely exist when being fetched from the associated skeleton JSP during normal portal rendering.request
- The current HTTPServletRequest instance
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2010, Oracle. All rights reserved.