Constants' Group FrameSearchFlag

Overview

Module

Use

Devguide

Index

Constants

Constants' Details

:: com :: sun :: star :: frame ::

constants group FrameSearchFlag

Description: these types describe the algorithm to be used to search a frame; Such flags will be used on methods XFrame::findFrame(), XDispatchProvider::queryDispatch() or XComponentLoader::loadComponentFromURL() if no special target frame name (e.g. "_blank", "_self") is used.
See also: XFrame::findFrame(), XDispatchProvider::queryDispatch(), XComponentLoader::loadComponentFromURL()

Developers Guide: OfficeDev - Handling Documents - Loading Documents - Target Frame

Constants
AUTO	[ DEPRECATED ] no longer supported
PARENT	allows search on the parent frames
SELF	includes the start frame himself
CHILDREN	includes all child frames of the start frame
CREATE	frame will be created if not found
SIBLINGS	includes the direct siblings of the start frame
TASKS	allow the search outside the current sub task tree of the whole possible frame tree
ALL	includes all frames except frames in other tasks sub trees but doesn't create any new frame
GLOBAL	searches in the whole hierarchy of frames but doesn't create any new frame

Constants' Details

AUTO

const long AUTO = 0; Usage Restrictions deprecated Description no longer supported Using of this flag will do nothing. Use right combination of other flags instead of this one.

PARENT

const long PARENT = 1; Description allows search on the parent frames

SELF

const long SELF = 2; Description includes the start frame himself

CHILDREN

const long CHILDREN = 4; Description includes all child frames of the start frame Note: That means all direct children and of course her childrens too. Search doesn't stop at the next level inside the tree!

CREATE

const long CREATE = 8; Description frame will be created if not found

SIBLINGS

const long SIBLINGS = 16; Description includes the direct siblings of the start frame Normaly it's interpreted as search on the direct childs of the parent only. But in combination with e.g. the CHILDREN flag it can include all children of it too.

TASKS

const long TASKS = 32; Description allow the search outside the current sub task tree of the whole possible frame tree If this flag isn't present, any search from bottom to top has to stop, if a top frame will be reached. It doesn't influence a search from top to bottom. But it can be used at the root of the frame tree to search on direct childrens of it only. Because the direct children of the root node are the root's of the task sub trees, which are top frames too. Instead of using the CHILDREN flag there, it's possible so to supress a deeper search so.

ALL

const long ALL = 23; Description includes all frames except frames in other tasks sub trees but doesn't create any new frame

GLOBAL

const long GLOBAL = 55; Description searches in the whole hierarchy of frames but doesn't create any new frame

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