AbstractButtonPresentationContext Class

com.bea.netuix.servlets.controls.window
AbstractButtonPresentationContext Class

public class AbstractButtonPresentationContext

    extends PresentationContext

Used to provide access to presentation-related attributes specific to the Button in use. Typically used during portal rendering via look and feel skeleton files (e.g. buttondelete.jsp).

Related Topics

AbstractButtonPresentationContext.getAbstractButtonPresentationContext(HttpServletRequest)


Hierarchy
Object
  ControlContext
    PresentationContext
      AbstractButtonPresentationContext
All Implemented Interfaces

Serializable
Direct Known Subclasses

ButtonPresentationContext, ToggleButtonPresentationContext

Field Summary

public static final String
CLASS_NAME
String
   
Fields from  com.bea.netuix.servlets.controls.ControlContext
debug
 

Constructor Summary

 

Method Summary

public static AbstractButtonPresentationContext
getAbstractButtonPresentationContext(HttpServletRequest request)
This is a convenience method for returning a reference to the one and only AbstractButtonPresentationContext for a given Button.
public String
getAltText()
Returns the value specified by the altText attribute in the Button portal component.
protected String
getContextKey()
public String
getEvent()
event represents a request parameter value which corresponds to a request parameter retrieved via getEventParam.
public String
getEventParam()
eventParam represents a request parameter name, to be appended to the Buttons HREF URL, for example.
public String
getImage()
The image attribute represents the name of the standard image for this Button.
public String
getImageSrc()
The imageSrc attribute represents the content URI to the standard image for this Button, as might be supplied to the src attribute of an <img> tag.
public String
getName()
Returns the value specified by the name attribute in the Button portal component.
public String
getRolloverImage()
The rolloverImage attribute represents the name of the image to be rendered upon rollover of this Button.
public String
getRolloverImageSrc()
The rolloverImageSrc attribute represents the content URI to the image to be rendered upon rollover of this Button, as might be supplied to the src attribute of an >img< tag.
public String
getWindowLabel()
Get the instance label (portlet) or definition label (book, page) of the parent Window for this Button portal component.
public boolean
isParentPortlet()
Will return true if this Button's parent is an instance of Portlet.
 
Methods from  com.bea.netuix.servlets.controls.PresentationContext
getChildren, getChildren, getFirstChild, getParsedProperties, getPresentationClass, getPresentationId, getPresentationStyle, getProperties, getProperty, getProperty, getPropertyAsBoolean, getPropertyAsInt, getResolvedLocale, getTagName, isVisible, setVisible
 
Methods from  com.bea.netuix.servlets.controls.ControlContext
getContextFromRequest, getControl, getRequestKey, getUniqueId, removeContextFromRequest, setContextInRequest
 
Methods from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
   

Field Detail

CLASS_NAME

public static final String CLASS_NAME

 

Constructor Detail

 

Method Detail

getAbstractButtonPresentationContext(HttpServletRequest) Method

public static AbstractButtonPresentationContext getAbstractButtonPresentationContext(HttpServletRequest request)
This is a convenience method for returning a reference to the one and only AbstractButtonPresentationContext for a given Button. Note this method will only work if called from within a portal (e.g. buttondelete.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.

Parameters

request
The current HTTPServletRequest instance

Returns

A reference to the current AbstractButtonPresentationContext, if any

getAltText() Method

public String getAltText()
Returns the value specified by the altText attribute in the Button portal component.

Returns

the value of altText, if any

getContextKey() Method

protected String getContextKey()
Overrides
ControlContext.getContextKey()

getEvent() Method

public String getEvent()
event represents a request parameter value which corresponds to a request parameter retrieved via getEventParam.

Returns

the value of event, if any

getEventParam() Method

public String getEventParam()
eventParam represents a request parameter name, to be appended to the Buttons HREF URL, for example. The value for the request parameter can be retrieved via the getEvent method.

Returns

the value of eventParam, if any

getImage() Method

public String getImage()
The image attribute represents the name of the standard image for this Button.

Returns

the value of the image attribute for this Button portal component, if any

getImageSrc() Method

public String getImageSrc()
The imageSrc attribute represents the content URI to the standard image for this Button, as might be supplied to the src attribute of an <img> tag.

Returns

the value of the imageSrc attribute for this Button portal component, if any

getName() Method

public String getName()
Returns the value specified by the name attribute in the Button portal component.

Returns

Returns the name of the button, if any

getRolloverImage() Method

public String getRolloverImage()
The rolloverImage attribute represents the name of the image to be rendered upon rollover of this Button.

Returns

the value of the rolloverImage attribute for this Button portal component, if any

getRolloverImageSrc() Method

public String getRolloverImageSrc()
The rolloverImageSrc attribute represents the content URI to the image to be rendered upon rollover of this Button, as might be supplied to the src attribute of an >img< tag.

Returns

the value of the rolloverImageSrc attribute for this Button portal component, if any

getWindowLabel() Method

public String getWindowLabel()
Get the instance label (portlet) or definition label (book, page) of the parent Window for this Button portal component. This can be used to determine which resource a particular Button is residing on.

Returns

instance or definition label

isParentPortlet() Method

public boolean isParentPortlet()
Will return true if this Button's parent is an instance of Portlet.

Returns

true if this button is hosted inside a portlet (as opposed to a Book)