This component provides the client-side representation of a frame.
Only a single instance of a frame component can be created per XDIME 2 document.
Frame components are created from the frame region not from markup elements and therefore have no identifier by which page authors can reference them during the linking phase of the page construction process.
This component provides the following methods:
This method is intended to be called before concealing the current page in the frame. This allows the current page to prevent the frame from concealing it, e.g. if that would result in a loss of information provided by the user. Ideally, this method should give the user the option of choosing whether or not to allow the page to be replaced. The method returns 'true' if the frame can replace the current page, 'false' otherwise. In the latter case, the method can be used to provide some feedback to the user explaining why the page cannot be replaced so that the user can rectify the problem and allow further navigation.
| Parameter | Description | Type |
|---|---|---|
| event | The event which provides access to the frame. | cf2:frameConcealingPage |
This method should be called after the page params have been updated but before the page is displayed. It allows the page to update its content based on the parameters when the page is about to be displayed.
| Parameter | Description | Type |
|---|---|---|
| event | The event which provides access to the frame. | cf2:frameDisplayingPage |
The following table lists the observable properties associated with this component.
| Property | Description | Type | Access |
|---|---|---|---|
| history | A reference to the history component that the frame uses to keep track of the history of pages displayed in it. The initial value of the property is a newly created instance of the history component. | History | read |
| page | A reference to the current page displayed in the frame. The value of the property is null if no page is currently displayed. The initial value of the property is a reference to the initial page that has been associated with the frame, or null if the frame has no initial page. | Page | read |
The cf2:frameConcealingPage event is fired whenever the current page is about to be concealed.
| Property | Description | Type |
|---|---|---|
| target | The frame whose current page is about to be concealed. | Frame |
The cf2:frameDisplayingPage event is fired whenever a page is about to be displayed.