oracle.cabo.servlet.ui.data
Class PageURLBoundValue

java.lang.Object
  |
  +--oracle.cabo.servlet.ui.data.PageURLBoundValue

All Implemented Interfaces:

BoundValue

public class PageURLBoundValue

extends java.lang.Object

implements BoundValue

BoundValue implementation that will dynamically encode an URL to point to a UIX Controller page. It corresponds to the UIX <ctrl:pageURL> element.

This BoundValue supports setting the following features:

• Page name: can be data bound
• A list of Page property key/value pairs: the values can be individually data bound
• Event name: can be data bound
• Event parameter key/value pairs: the values can be individually data bound
• Anchor name: can be data bound
• Whether to copy the State object from the current page into the target URL (defaults to true)
• Whether to copy the page properties from the current page into the target URL (defaults to true)

Inner Class Summary

static class

PageURLBoundValue.Parameter A single parameter of an URL.

Constructor Summary

PageURLBoundValue()
Creates a PageURLBoundValue.

PageURLBoundValue(Page page)
Creates a PageURLBoundValue, hardcoded to a specific page.

Method Summary

java.lang.String	getAnchor() Gets the anchor name.
java.lang.String	getEvent() Gets the event name.
java.lang.String	getName() Returns the harcoded page name.
PageURLBoundValue.Parameter[]	getParameters() Returns the list of event parameters.
PageURLBoundValue.Parameter[]	getProperties() Returns the list of page properties.
java.lang.Object	getValue(RenderingContext rContext) Returns the value of the RenderingContext.
boolean	isPropertiesPreserved() Sets whether the all the Page properties from the page being rendered should be copied to the target page.
boolean	isStatePreserved() Sets whether the State object from the page being rendered should be copied to the target page.
void	setAnchor(java.lang.String anchor) Sets the anchor name.
void	setAnchorBinding(BoundValue anchorBinding) Sets a BoundValue that will dynamically evaluate the anchor name.
void	setEvent(java.lang.String event) Sets the event name.
void	setEventBinding(BoundValue eventBinding) Sets a BoundValue that will dynamically evaluate the event name.
void	setName(java.lang.String name) Sets a harcoded page name.
void	setNameBinding(BoundValue nameBinding) Sets a page name that will be dynamically computed.
void	setParameters(PageURLBoundValue.Parameter[] parameters) Sets the list of event parameters.
void	setProperties(PageURLBoundValue.Parameter[] properties) Sets the list of page properties.
void	setPropertiesPreserved(boolean propertiesPreserved) Sets whether the Page properties from the page being rendered should be copied to the target page.
void	setStatePreserved(boolean statePreserved) Sets whether the State object from the page being rendered should be copied to the target page.

Methods inherited from class java.lang.Object

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

Constructor Detail

PageURLBoundValue

public PageURLBoundValue()

Creates a PageURLBoundValue.

PageURLBoundValue

public PageURLBoundValue(Page page)

Creates a PageURLBoundValue, hardcoded to a specific page. The values of "name", "statePerserved", and "properties" will all be ignored.

Parameters:

page - the Page to link to

Method Detail

getName

public java.lang.String getName()

Returns the harcoded page name. If neither this or the name binding are set, the name will default to the current page.

setName

public void setName(java.lang.String name)

Sets a harcoded page name. If neither this or the name binding are set, the name will default to the current page. The value of this name is always interpreted relative to the current page. Consequently, absolute page names must be prefixed by a slash.

See Also:

Page, setNameBinding(oracle.cabo.ui.data.BoundValue)

setNameBinding

public void setNameBinding(BoundValue nameBinding)

Sets a page name that will be dynamically computed. If neither this or the name binding are set, the name will default to the current page. The value is always interpreted relative to the current page. Consequently, absolute page names must be prefixed by a slash.

See Also:

Page

isStatePreserved

public boolean isStatePreserved()

Sets whether the State object from the page being rendered should be copied to the target page. This value defaults to true.

See Also:

State, Page.setState(oracle.cabo.servlet.state.State)

setStatePreserved

public void setStatePreserved(boolean statePreserved)

Sets whether the State object from the page being rendered should be copied to the target page. This value defaults to true.

See Also:

State, Page.setState(oracle.cabo.servlet.state.State)

isPropertiesPreserved

public boolean isPropertiesPreserved()

Sets whether the all the Page properties from the page being rendered should be copied to the target page. This value defaults to true.

See Also:

Page.setProperty(java.lang.String, java.lang.String)

setPropertiesPreserved

public void setPropertiesPreserved(boolean propertiesPreserved)

Sets whether the Page properties from the page being rendered should be copied to the target page. This value defaults to true.

See Also:

Page.setProperty(java.lang.String, java.lang.String)

getEvent

public java.lang.String getEvent()

Gets the event name.

setEvent

public void setEvent(java.lang.String event)

Sets the event name.

setEventBinding

public void setEventBinding(BoundValue eventBinding)

Sets a BoundValue that will dynamically evaluate the event name.

getAnchor

public java.lang.String getAnchor()

Gets the anchor name.

setAnchor

public void setAnchor(java.lang.String anchor)

Sets the anchor name.

setAnchorBinding

public void setAnchorBinding(BoundValue anchorBinding)

Sets a BoundValue that will dynamically evaluate the anchor name.

setParameters

public void setParameters(PageURLBoundValue.Parameter[] parameters)

Sets the list of event parameters.

getParameters

public PageURLBoundValue.Parameter[] getParameters()

Returns the list of event parameters.

setProperties

public void setProperties(PageURLBoundValue.Parameter[] properties)

Sets the list of page properties.

getProperties

public PageURLBoundValue.Parameter[] getProperties()

Returns the list of page properties.

getValue

public java.lang.Object getValue(RenderingContext rContext)

Returns the value of the RenderingContext.

Specified by:

getValue in interface BoundValue

Following copied from interface: oracle.cabo.ui.data.BoundValue

Parameters:

context - the rendering context