Overview | Module | Use | Devguide | Index

Methods' Summary | Methods' Details | Attributes' Summary | Attributes' Details

:: com :: sun :: star :: frame ::
interface XFramesSupplier
  Base Hierarchy
      ::com::sun::star::uno::XInterface
       |
       +-::com::sun::star::lang::XComponent
          |
          +-XFrame
             |
             +-XFramesSupplier
Description provides access to sub frames of current one See also XFrames Developers Guide 6.1.3 Office Development - OpenOffice.org Application Environment - Using the Component Framework - Frames - XFramesSupplier 6.1.4 Office Development - OpenOffice.org Application Environment - 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 © 2003 Sun Microsystems, Inc.