Skip navigation links

oracle.adf.view.core.component.customizable
Class ShowDetailFrame

java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXShowDetail
oracle.adf.view.core.component.customizable.ShowDetailFrame

All Implemented Interfaces:

javax.faces.component.StateHolder

Direct Known Subclasses:

ShowDetailFrame, ShowDetailFrame

public class ShowDetailFrame

extends org.apache.myfaces.trinidad.component.UIXShowDetail

The ShowDetailFrame component wraps it's children in a border and provides several customization options for the wrapped content.

  Example: 
 
  <cust:showDetailFrame text="Show Detail Frame 1" >
    <af:objectImage source="graph.gif" />
  </cust:showDetailFrame>
  
  

Field Summary

static java.lang.String	BACKGROUND_DARK
static org.apache.myfaces.trinidad.bean.PropertyKey	BACKGROUND_KEY
static java.lang.String	BACKGROUND_LIGHT
static java.lang.String	BACKGROUND_MEDIUM
static org.apache.myfaces.trinidad.bean.PropertyKey	CLIENT_LISTENERS_KEY
static java.lang.String	COMPONENT_FAMILY
static org.apache.myfaces.trinidad.bean.PropertyKey	CONTAINS_IFRAME_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CONTENT_INLINE_STYLE_KEY Deprecated. use CONTENT_STYLE_KEY instead
static org.apache.myfaces.trinidad.bean.PropertyKey	CONTENT_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	CUSTOMIZATION_ID_KEY Deprecated.
static java.lang.String	DISPLAY_ACTIONS_ALWAYS
static org.apache.myfaces.trinidad.bean.PropertyKey	DISPLAY_ACTIONS_KEY
static java.lang.String	DISPLAY_ACTIONS_ON_HOVER
static org.apache.myfaces.trinidad.bean.PropertyKey	DISPLAY_HEADER_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	DISPLAY_SHADOW_KEY
static java.lang.String	EXPANSION_MODE_MAXIMIZED
static java.lang.String	EXPANSION_MODE_MINIMIZED
static java.lang.String	EXPANSION_MODE_NORMAL
static org.apache.myfaces.trinidad.bean.PropertyKey	EXPANSIONMODE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	HEADER_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ICON_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INHERIT_GLOBAL_ACTIONS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	INLINE_STYLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	IS_EDITABLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	IS_HELP_AVAILABLE_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PARENT_PC_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	PARTIAL_TRIGGERS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	ROOT_PARENT_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	SHORT_DESC_KEY
static java.lang.String	SHOW_MINIMIZE_ACTION_CHROME
static org.apache.myfaces.trinidad.bean.PropertyKey	SHOW_MINIMIZE_ACTION_KEY
static java.lang.String	SHOW_MINIMIZE_ACTION_NONE
static org.apache.myfaces.trinidad.bean.PropertyKey	SHOW_MOVE_ACTION_KEY
static java.lang.String	SHOW_MOVE_ACTION_MENU
static java.lang.String	SHOW_MOVE_ACTION_NONE
static org.apache.myfaces.trinidad.bean.PropertyKey	STYLE_CLASS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	TEXT_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE

Fields inherited from class org.apache.myfaces.trinidad.component.UIXShowDetail

COMPONENT_TYPE, DISCLOSED_KEY, DISCLOSED_TRANSIENT_KEY, DISCLOSURE_LISTENER_KEY, IMMEDIATE_KEY

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Fields inherited from class javax.faces.component.UIComponent

bindings

Constructor Summary

protected

ShowDetailFrame(java.lang.String rendererType) Constructs an instance of the ShowDetailFrame component.

Method Summary

void	broadcast(javax.faces.event.FacesEvent facesEvent) In addition to the default javax.faces.component.UIComponent#broadcast(javax.faces.event.FacesEvent) processing, passes the AttributeChangeEvent and DisclosureEvent that is broadcast, to the method referenced by actionListener (if any), and then to the default listeners registered on the Application, which will invoke attached MethodBindings.
java.lang.String	getBackground() Returns the background attribute of the component
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
oracle.adf.view.rich.event.ClientListenerSet	getClientListeners() Gets a set of client listeners.
java.lang.String	getContentInlineStyle() Deprecated. use getContentStyle() instead
java.lang.String	getContentStyle() Returns the contentStyle attribute of the component
java.lang.String	getCustomizationId() Deprecated.
java.lang.String	getDisplayActions() Controls the display of all seeded interactions on the component.
boolean	getDisplayHeader() Returns the displayHeader attribute value of the component.
boolean	getDisplayShadow() Returns the displayShadow attribute value of the component.
java.lang.String	getExpansionMode() Gets the expansionMode of the component.
java.lang.String	getFamily() Returns the component family.
java.lang.String	getHeaderStyle() Returns the headerStyle attribute of the component
java.lang.String	getIcon() Returns the icon attribute of the component
boolean	getInheritGlobalActions()
java.lang.String	getInlineStyle() Returns the inlineStyle attribute of the component
java.lang.String	getShortDesc() Returns the shortDesc attribute of the component
java.lang.String	getShowMinimizeAction() Controls the display of minimize and restore interaction on the component.
java.lang.String	getShowMoveAction() Controls the display of Move Up/Move Down/Move Right/Move Left interaction on the component.
java.lang.String	getStyleClass() Returns the styleClass attribute of the component
java.lang.String	getText() Returns the title of the component in String form.
void	setBackground(java.lang.String background) Sets the background attribute of the component.
void	setClientListeners(oracle.adf.view.rich.event.ClientListenerSet clientListeners) Sets a set of client listeners.
void	setContentInlineStyle(java.lang.String contentInlineStyle) Deprecated. use setContentStyle(java.lang.String) instead
void	setContentStyle(java.lang.String contentStyle) Sets the contentStyle attribute of the component.
void	setCustomizationId(java.lang.String custId) Deprecated.
void	setDisplayActions(java.lang.String available) Controls display of all seeded interactions on the component.
void	setDisplayHeader(boolean displayHeader) Sets the displayHeader attribute value of the component.
void	setDisplayShadow(boolean displayShadow) Sets the displayShadow attribute value of the component.
void	setExpansionMode(java.lang.String expansionMode) Sets the expansionMode of the component.
void	setHeaderStyle(java.lang.String headerStyle) Sets the headerStyle attribute of the component.
void	setIcon(java.lang.String icon) Sets the icon attribute of the component.
void	setInheritGlobalActions(boolean inheritGlobalActions)
void	setInlineStyle(java.lang.String inlineStyle) Sets the inlineStyle attribute of the component.
void	setShortDesc(java.lang.String shortDesc) Sets the shortDesc attribute of the component.
void	setShowMinimizeAction(java.lang.String available) Controls display of minimize / restore interaction on the component.
void	setShowMoveAction(java.lang.String available) Controls the display of Move Up/Move Down/Move Right/Move Left interaction on the component.
void	setStyleClass(java.lang.String styleClass) Sets the styleClass attribute of the component.
void	setText(java.lang.String text) Sets the text attribute of the component.

Methods inherited from class org.apache.myfaces.trinidad.component.UIXShowDetail

addDisclosureListener, getDisclosureListener, getDisclosureListeners, isDisclosed, isDisclosedTransient, isImmediate, processDecodes, processUpdates, processValidators, queueEvent, removeDisclosureListener, setDisclosed, setDisclosedTransient, setDisclosureListener, setDisclosureListener, setImmediate

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, removeAttributeChangeListener, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent

addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getContainerClientId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

BACKGROUND_LIGHT

public static final java.lang.String BACKGROUND_LIGHT

See Also:

Constant Field Values

BACKGROUND_MEDIUM

public static final java.lang.String BACKGROUND_MEDIUM

See Also:

Constant Field Values

BACKGROUND_DARK

public static final java.lang.String BACKGROUND_DARK

See Also:

Constant Field Values

EXPANSION_MODE_NORMAL

public static final java.lang.String EXPANSION_MODE_NORMAL

See Also:

Constant Field Values

EXPANSION_MODE_MINIMIZED

public static final java.lang.String EXPANSION_MODE_MINIMIZED

See Also:

Constant Field Values

EXPANSION_MODE_MAXIMIZED

public static final java.lang.String EXPANSION_MODE_MAXIMIZED

See Also:

Constant Field Values

SHOW_MOVE_ACTION_MENU

public static final java.lang.String SHOW_MOVE_ACTION_MENU

See Also:

Constant Field Values

SHOW_MOVE_ACTION_NONE

public static final java.lang.String SHOW_MOVE_ACTION_NONE

See Also:

Constant Field Values

SHOW_MINIMIZE_ACTION_CHROME

public static final java.lang.String SHOW_MINIMIZE_ACTION_CHROME

See Also:

Constant Field Values

SHOW_MINIMIZE_ACTION_NONE

public static final java.lang.String SHOW_MINIMIZE_ACTION_NONE

See Also:

Constant Field Values

DISPLAY_ACTIONS_ALWAYS

public static final java.lang.String DISPLAY_ACTIONS_ALWAYS

See Also:

Constant Field Values

DISPLAY_ACTIONS_ON_HOVER

public static final java.lang.String DISPLAY_ACTIONS_ON_HOVER

See Also:

Constant Field Values

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

TEXT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey TEXT_KEY

SHORT_DESC_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY

PARTIAL_TRIGGERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY

EXPANSIONMODE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey EXPANSIONMODE_KEY

ICON_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ICON_KEY

CONTAINS_IFRAME_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTAINS_IFRAME_KEY

SHOW_MINIMIZE_ACTION_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOW_MINIMIZE_ACTION_KEY

SHOW_MOVE_ACTION_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHOW_MOVE_ACTION_KEY

IS_EDITABLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey IS_EDITABLE_KEY

IS_HELP_AVAILABLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey IS_HELP_AVAILABLE_KEY

DISPLAY_ACTIONS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DISPLAY_ACTIONS_KEY

DISPLAY_HEADER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DISPLAY_HEADER_KEY

DISPLAY_SHADOW_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DISPLAY_SHADOW_KEY

ROOT_PARENT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ROOT_PARENT_KEY

PARENT_PC_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey PARENT_PC_KEY

INLINE_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY

STYLE_CLASS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY

CONTENT_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_STYLE_KEY

HEADER_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey HEADER_STYLE_KEY

CONTENT_INLINE_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_INLINE_STYLE_KEY

Deprecated. use CONTENT_STYLE_KEY instead

BACKGROUND_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey BACKGROUND_KEY

CLIENT_LISTENERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY

INHERIT_GLOBAL_ACTIONS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey INHERIT_GLOBAL_ACTIONS_KEY

CUSTOMIZATION_ID_KEY

@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY

Deprecated.

Constructor Detail

ShowDetailFrame

protected ShowDetailFrame(java.lang.String rendererType)

Constructs an instance of the ShowDetailFrame component.

Method Detail

getFamily

public java.lang.String getFamily()

Returns the component family.

Overrides:

getFamily in class org.apache.myfaces.trinidad.component.UIXShowDetail

getText

public java.lang.String getText()

Returns the title of the component in String form.

Returns:

String containing the text attribute value

setText

public void setText(java.lang.String text)

Sets the text attribute of the component.

Parameters:

text - the new text attribute value

getIcon

public java.lang.String getIcon()

Returns the icon attribute of the component

Returns:

String representing the icon attribute value

setIcon

public void setIcon(java.lang.String icon)

Sets the icon attribute of the component.

Parameters:

icon - the new icon attribute value

getShortDesc

public java.lang.String getShortDesc()

Returns the shortDesc attribute of the component

Returns:

String representing the shortDesc attribute value

setShortDesc

public void setShortDesc(java.lang.String shortDesc)

Sets the shortDesc attribute of the component.

Parameters:

shortDesc - the new shortDesc attribute value

getInlineStyle

public java.lang.String getInlineStyle()

Returns the inlineStyle attribute of the component

Returns:

String representing the inlineStyle attribute value

setInlineStyle

public void setInlineStyle(java.lang.String inlineStyle)

Sets the inlineStyle attribute of the component.

Parameters:

inlineStyle - the new inlineStyle attribute value

getStyleClass

public java.lang.String getStyleClass()

Returns the styleClass attribute of the component

Returns:

String representing the styleClass attribute value

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Sets the styleClass attribute of the component.

Parameters:

styleClass - the new styleClass attribute value

getContentInlineStyle

public java.lang.String getContentInlineStyle()

Deprecated. use getContentStyle() instead

setContentInlineStyle

public void setContentInlineStyle(java.lang.String contentInlineStyle)

Deprecated. use setContentStyle(java.lang.String) instead

getContentStyle

public java.lang.String getContentStyle()

Returns the contentStyle attribute of the component

Returns:

String representing the contentStyle attribute value

setContentStyle

public void setContentStyle(java.lang.String contentStyle)

Sets the contentStyle attribute of the component.

Parameters:

contentStyle - the new contentStyle attribute value

setHeaderStyle

public void setHeaderStyle(java.lang.String headerStyle)

Sets the headerStyle attribute of the component.

Parameters:

headerStyle - the new headerStyle attribute value

getHeaderStyle

public java.lang.String getHeaderStyle()

Returns the headerStyle attribute of the component

Returns:

String representing the headerStyle attribute value

getBackground

public java.lang.String getBackground()

Returns the background attribute of the component

Returns:

String representing the background attribute value

setBackground

public void setBackground(java.lang.String background)

Sets the background attribute of the component.

Parameters:

background - the new background attribute value

getExpansionMode

public java.lang.String getExpansionMode()

Gets the expansionMode of the component. This specifies whether the component is currently in minimized, maximized, or normal state.

Returns:

String value of the current expansion mode

setExpansionMode

public void setExpansionMode(java.lang.String expansionMode)

Sets the expansionMode of the component.

Parameters:

expansionMode - the new expansion mode - an be maximized, minimized, or restore.

See Also:

getExpansionMode()

getDisplayActions

public java.lang.String getDisplayActions()

Controls the display of all seeded interactions on the component. If set to false, none of the inherent actions will be available on the component.

Returns:

boolean the current value of the isSeededInteractionsAvailable attribute

setDisplayActions

public void setDisplayActions(java.lang.String available)

Controls display of all seeded interactions on the component. If set to false, none of the inherent actions will be available on the component.

Parameters:

available - new value of the attribute

getShowMinimizeAction

public java.lang.String getShowMinimizeAction()

Controls the display of minimize and restore interaction on the component. If set to false, minimize / restore actions will not be available on the component.

Returns:

the current value of isMinimizable attribute

setShowMinimizeAction

public void setShowMinimizeAction(java.lang.String available)

Controls display of minimize / restore interaction on the component. If set to false, minimize / restore actions will not be available on the component.

Parameters:

available - new value of the attribute

getShowMoveAction

public java.lang.String getShowMoveAction()

Controls the display of Move Up/Move Down/Move Right/Move Left interaction on the component. If set to false, Move actions will not be available on the component.

Returns:

the current value of IsMovable attribute

setShowMoveAction

public void setShowMoveAction(java.lang.String available)

Controls the display of Move Up/Move Down/Move Right/Move Left interaction on the component. If set to false, Move actions will not be available on the component.

Parameters:

available - the new value

getClientListeners

public final oracle.adf.view.rich.event.ClientListenerSet getClientListeners()

Gets a set of client listeners.

setClientListeners

public final void setClientListeners(oracle.adf.view.rich.event.ClientListenerSet clientListeners)

Sets a set of client listeners.

broadcast

public void broadcast(javax.faces.event.FacesEvent facesEvent)
               throws javax.faces.event.AbortProcessingException

In addition to the default javax.faces.component.UIComponent#broadcast(javax.faces.event.FacesEvent) processing, passes the AttributeChangeEvent and DisclosureEvent that is broadcast, to the method referenced by actionListener (if any), and then to the default listeners registered on the Application, which will invoke attached MethodBindings.

Overrides:

broadcast in class org.apache.myfaces.trinidad.component.UIXShowDetail

Parameters:

facesEvent - the facesEvent object

Throws:

javax.faces.event.AbortProcessingException

getDisplayHeader

public boolean getDisplayHeader()

Returns the displayHeader attribute value of the component.

Returns:

boolean value of displayHeader property

setDisplayHeader

public void setDisplayHeader(boolean displayHeader)

Sets the displayHeader attribute value of the component.

Parameters:

displayHeader - new value of attribute

getDisplayShadow

public boolean getDisplayShadow()

Returns the displayShadow attribute value of the component.

Returns:

boolean value of displayShadow property

setDisplayShadow

public void setDisplayShadow(boolean displayShadow)

Sets the displayShadow attribute value of the component.

Parameters:

displayShadow - new value of attribute

getInheritGlobalActions

public boolean getInheritGlobalActions()

setInheritGlobalActions

public void setInheritGlobalActions(boolean inheritGlobalActions)

getCustomizationId

@Deprecated
public final java.lang.String getCustomizationId()

Deprecated.

Get the value of CustomizationId attribute.

Returns:

the current value of the CustomizationId attribute.

setCustomizationId

@Deprecated
public final void setCustomizationId(java.lang.String custId)

Deprecated.

Sets the value of CustomizationId attribute.

Parameters:

unique - custId

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()

Overrides:

getBeanType in class org.apache.myfaces.trinidad.component.UIXShowDetail

Skip navigation links