Interface XFramesSupplier

Attributes' Summary

Attributes' Details

interface XFramesSupplier

Base Interfaces

XFramesSupplier
┗ XFrame
   ┗ ::com::sun::star::lang::XComponent

XFrame

(referenced interface's summary:): a frame object can be considered to be an "anchor" object where a component can be attached to.

Description: provides access to sub frames of current one
See also: XFrames

Developers Guide: OfficeDev - Component - Frames - XFramesSupplier; OfficeDev - Creating Frames Manually - Setting Components into Frame Hierarchies

Methods' Summary
getFrames	provides access to this container and to all other XFramesSupplier which are available from this node of frame tree
getActiveFrame	gets the current active frame of this container (not of any other available supplier)
setActiveFrame	is called on activation of a direct sub-frame.

Methods' Details

getFrames

XFrames
getFrames();

Description: provides access to this container and to all other XFramesSupplier which are available from this node of frame tree
Returns: the collection of frames which is represented by a FramesContainer.

getActiveFrame

XFrame
getActiveFrame();

Description: gets the current active frame of this container (not of any other available supplier); This may be the frame itself. The active frame is defined as the frame which contains (recursively) the window with the focus. If no window within the frame contains the focus, this method returns the last frame which had the focus. If no containing window ever had the focus, the first frame within this frame is returned.
Returns: the Frame which is active within this frame.

setActiveFrame

void
setActiveFrame(	[in] XFrame	Frame );

Description

is called on activation of a direct sub-frame.

This method is only allowed to be called by a sub-frame according to XFrame::activate() or XFramesSupplier::setActiveFrame(). After this call XFramesSupplier::getActiveFrame() will return the frame specified by Frame.

In general this method first calls the method XFramesSupplier::setActiveFrame() at the creator frame with this as the current argument. Then it broadcasts the FrameActionEvent FrameAction::FRAME_ACTIVATED.

Note: Given parameter Frame must already exist inside the container (e.g., inserted by using XFrames::append())

Parameter Frame

the new active child frame inside this container

Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

API

SDK

Tips ‘n’ Tricks

Miscellaneous