|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.bea.netuix.application.instance.PortletInstance
public class PortletInstance
Represents a customized version of a PortletDefinition
.
Field Summary | |
---|---|
protected LocalizationResource |
localizationResource
|
Constructor Summary | |
---|---|
PortletInstance(LocalizationResource localizationResource,
ThemeDefinitionId themeDefinitionId,
short titlebarOrientation,
boolean defaultMinimized,
String instanceLabel)
Constructor to create a new PortletInstance object. |
|
PortletInstance(LocalizationResource localizationResource,
ThemeDefinitionId themeDefinitionId,
short titlebarOrientation,
boolean defaultMinimized,
String instanceLabel,
String producerHandle,
String portletHandle,
byte stateChangeFlag,
boolean requiresUrlTemplates,
boolean templatesStoredInSession,
byte[] portletState,
boolean producerOfferedPortlet)
Overloaded constructor to create a WSRP remote portlet. |
Method Summary | |
---|---|
Date |
getCreatedDate()
|
String |
getDescription()
Retrieves this portlet's localized description from its LocalizationResource . |
String |
getInstanceLabel()
Returns the instance label for this portlet. |
String |
getLabel()
Returns the instance label for this portlet. |
LocalizationIntersectionId |
getLocalizationIntersectionId()
Returns the LocalizationIntersectionId for this portlet. |
LocalizationResource |
getLocalizationResource()
Returns the LocalizationResource associated with this
PortletDefinition based on the locale of the request used
for retrieving the PortletInstance . |
Date |
getModifiedDate()
|
PlaceableDefinition |
getPlaceableDefinition()
Returns the PlaceableDefinition associated with this portlet. |
PlaceableInstanceId |
getPlaceableInstanceId()
Returns the PlaceableInstanceId for the
PlaceableInstance associated with this portlet. |
PlacementId |
getPlacementId()
Returns the PlacementId for this portlet. |
PortletDefinition |
getPortletDefinition()
Returns the PortletDefinition that this portlet was created from. |
PortletDefinitionId |
getPortletDefinitionId()
Returns the PortletDefinitionId for the
PortletDefinition that this portlet was created from. |
String |
getPortletHandle()
Returns the portlet handle associated with this portlet if it is a WSRP remote portlet, null otherwise. |
PortletInstanceId |
getPortletInstanceId()
Returns the PortletInstanceId for this portlet. |
byte[] |
getPortletState()
Returns the portlet state for a WSRP remote portlet |
String |
getProducerHandle()
Returns the producer handle associated with this portlet if it is a WSRP remote portlet, null otherwise. |
byte |
getStateChangeFlag()
Returns state change flag associated with this portlet if it is a WSRP remote portlet. |
ThemeDefinitionId |
getThemeDefinitionId()
Returns the ThemeDefinitionId of theme associated with this
PortletInstance . |
String |
getTitle()
Retrieves this portlet's localized title from its LocalizationResource . |
short |
getTitlebarOrientation()
Returns the titlebar orientation for this PortletInstance |
boolean |
isDefaultMinimized()
Returns if this portlet is minimized by default. |
boolean |
isProducerOfferedPortlet()
Returns whether a WSRP remote portlet has not been customized by a WSRP consumer |
boolean |
isRequiresUrlTemplates()
Returns whether a WSRP remote portlet requires url templates |
boolean |
isTemplatesStoredInSession()
Returns whether url templates are stored in the HttpSession for a WSRP remote portlet |
void |
setDefaultMinimized(boolean defaultMinimized)
Sets whether this portlet is default minimized. |
void |
setDescription(String description)
Update the description for the current locale. |
void |
setInstanceLabel(String instanceLabel)
Sets the instance label for this portlet. |
void |
setLocalizationResource(LocalizationResource localizationResource)
Sets the LocalizationResource for this portlet. |
void |
setPortletHandle(String portletHandle)
Sets the portlet handle for this portlet |
void |
setPortletState(byte[] portletState)
Sets the portlet state for a WSRP remote portlet |
void |
setProducerHandle(String producerHandle)
Sets the producer handle for this portlet |
void |
setProducerOfferedPortlet(boolean producerOfferedPortlet)
Sets whether a WSRP remote portlet is customized by a WSRP consumer |
void |
setRequiresUrlTemplates(boolean requiresUrlTemplates)
Sets whether a WSRP remote portlet requires url templates |
void |
setStateChangeFlag(byte stateChangeFlag)
Sets state change flag |
void |
setTemplatesStoredInSession(boolean templatesStoredInSession)
Sets whether url templates are stored in the HttpSession for a WSRP remote portlet |
void |
setThemeDefinitionId(ThemeDefinitionId themeDefinitionId)
Associates a theme with this portlet. |
void |
setTitle(String title)
Update the title for the current locale. |
void |
setTitlebarOrientation(short titlebarOrientation)
Sets the titlebar orientation for this portlet |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected LocalizationResource localizationResource
Constructor Detail |
---|
public PortletInstance(LocalizationResource localizationResource, ThemeDefinitionId themeDefinitionId, short titlebarOrientation, boolean defaultMinimized, String instanceLabel)
PortletInstance
object.
localizationResource
- localized title and descriptionthemeDefinitionId
- reference to a persisted ThemeDefinition
that is the theme for this portlettitlebarOrientation
- orientation of the titlebar as defined by
PortletView.ORIENTATION_LEFT
PortletView.ORIENTATION_RIGHT
PortletView.ORIENTATION_TOP
PortletView.ORIENTATION_BOTTOM
defaultMinimized
- if this portlet is minimized by defaultinstanceLabel
- customized label for this portlet instancepublic PortletInstance(LocalizationResource localizationResource, ThemeDefinitionId themeDefinitionId, short titlebarOrientation, boolean defaultMinimized, String instanceLabel, String producerHandle, String portletHandle, byte stateChangeFlag, boolean requiresUrlTemplates, boolean templatesStoredInSession, byte[] portletState, boolean producerOfferedPortlet)
localizationResource
- localized title and descriptionthemeDefinitionId
- reference to a persisted ThemeDefinition
that is the theme for this portlettitlebarOrientation
- orientation of the titlebar as defined by
PortletView.ORIENTATION_LEFT
PortletView.ORIENTATION_RIGHT
PortletView.ORIENTATION_TOP
PortletView.ORIENTATION_BOTTOM
defaultMinimized
- if this portlet is minimized by defaultinstanceLabel
- customized label for this portlet instanceproducerHandle
- producer handle for the WSRP producer that offers portlet
(specific to WSRP remote portlets)portletHandle
- portlet handle of this portlet,
(specific to WSRP remote portlets)stateChangeFlag
- state change flag,
(specific to WSRP remote portlets)requiresUrlTemplates
- whether this portlet requires url templates
(specific to WSRP remote portlets)templatesStoredInSession
- whether the url templates are stored in the HttpSession
(specific to WSRP remote portlets)portletState
- the portlet state
(specific to WSRP remote portlets)producerOfferedPortlet
- if this remote portlet has not been customized by the
WSRP consumer
(specific to WSRP remote portlets)Method Detail |
---|
public PortletInstanceId getPortletInstanceId()
PortletInstanceId
for this portlet.
Returns null
when the PortletInstance has not been retrieved
by using the persistence API.
PortletInstanceId
for this portletpublic PortletDefinition getPortletDefinition()
PortletDefinition
that this portlet was created from.
Returns null
when the PortletInstance has not been retrieved
by using the persistence API.
PortletDefinition
for this portletpublic PortletDefinitionId getPortletDefinitionId()
PortletDefinitionId
for the
PortletDefinition
that this portlet was created from.
Returns null
when the PortletInstance has not been retrieved
by using the persistence API.
PortletDefinitionId
for this portletpublic PlacementId getPlacementId()
PlacementId
for this portlet.
May be null
if this portlet has not been placed
on a page or if it has not been retrieved using the persistence API.
getPlacementId
in interface PlaceableInstance
PlacementId
for this portletpublic PlaceableInstanceId getPlaceableInstanceId()
PlaceableInstanceId
for the
PlaceableInstance
associated with this portlet.
Returns null
when the PortletInstance has not been retrieved
by using the persistence API.
getPlaceableInstanceId
in interface PlaceableInstance
PlaceableInstanceId
associated with this portletPlaceableInstance
public PlaceableDefinition getPlaceableDefinition()
PlaceableDefinition
associated with this portlet.
Returns null
when the PortletInstance has not been retrieved
by using the persistence API.
getPlaceableDefinition
in interface PlaceableInstance
PlaceableDefinition
associated with this portletPlaceableDefinition
public LocalizationIntersectionId getLocalizationIntersectionId()
LocalizationIntersectionId
for this portlet.
Returns null
if no LocalizationResource is associated with
this portlet. A LocalizationIntersectionId
is a reference to all
localized versions of title and description for an entity.
LocalizationIntersectionId
for this portletpublic LocalizationResource getLocalizationResource()
LocalizationResource
associated with this
PortletDefinition
based on the locale of the request used
for retrieving the PortletInstance
.
LocalizationResource
associated with this portletpublic void setLocalizationResource(LocalizationResource localizationResource)
LocalizationResource
for this portlet.
public String getTitle()
LocalizationResource
.
public String getDescription()
LocalizationResource
.
public ThemeDefinitionId getThemeDefinitionId()
ThemeDefinitionId
of theme associated with this
PortletInstance
.
ThemeDefinitionId
public void setThemeDefinitionId(ThemeDefinitionId themeDefinitionId)
themeDefinitionId
- of theme associated with this portletpublic String getInstanceLabel()
public String getLabel()
getLabel
in interface PlaceableInstance
public void setInstanceLabel(String instanceLabel)
public short getTitlebarOrientation()
PortletInstance
public void setTitlebarOrientation(short titlebarOrientation)
public boolean isDefaultMinimized()
public void setDefaultMinimized(boolean defaultMinimized)
defaultMinimized
- true to set the portlet to minimized by defaultpublic void setTitle(String title)
public void setDescription(String description)
public String getProducerHandle()
null
otherwise.
public void setProducerHandle(String producerHandle)
public String getPortletHandle()
null
otherwise.
public void setPortletHandle(String portletHandle)
public byte getStateChangeFlag()
public void setStateChangeFlag(byte stateChangeFlag)
public boolean isRequiresUrlTemplates()
public void setRequiresUrlTemplates(boolean requiresUrlTemplates)
public boolean isTemplatesStoredInSession()
public void setTemplatesStoredInSession(boolean templatesStoredInSession)
public byte[] getPortletState()
public void setPortletState(byte[] portletState)
public boolean isProducerOfferedPortlet()
public void setProducerOfferedPortlet(boolean producerOfferedPortlet)
public Date getCreatedDate()
public Date getModifiedDate()
|
Copyright © 2000, 2009, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |