com.sap.portal.pcm.attributes

Interface IAttrPcmNavigation

All Superinterfaces:
IAttrPcmGeneral, IAttrPcmLaunch
All Known Subinterfaces:
IAttriView, IAttrPage

public interface IAttrPcmNavigation
extends IAttrPcmLaunch

Defines navigation object specific attribute names.


Field Summary
static String ATTRIBUTE_ADD_TO_FAVORITES
          com.sap.portal.navigation.ShowAddToFavorites.
static String ATTRIBUTE_DRAGRELATE
          com.sap.portal.navigation.DragRelate.
static String ATTRIBUTE_ENTRY_POINT
          com.sap.portal.pcd.role.EntryPoint.
static String ATTRIBUTE_FOLDER_ENTRY
          com.sapportals.portal.navigation.FolderEntry.
static String ATTRIBUTE_JSCRIPT
          com.sap.portal.navigation.JScript.
static String ATTRIBUTE_LAUNCHABLE
          com.sap.portal.navigation.Launchable.
static String ATTRIBUTE_MERGE_PRIORITY
          com.sap.portal.navigation.MergePriority.
static String ATTRIBUTE_MERGEID
          com.sap.portal.navigation.MergeId.
static String ATTRIBUTE_MERGEPRIO
          Deprecated. As of NW04 SP13, replaced by ATTRIBUTE_SORT_PRIORITY.
static String ATTRIBUTE_MERGIBLE
          com.sap.portal.navigation.Mergible.
static String ATTRIBUTE_NAVINVISIBLE
          com.sap.portal.navigation.Invisible.
static String ATTRIBUTE_PICTOGRAM
          com.sapportals.portal.navigation.Pictogram.
static String ATTRIBUTE_SHOWTYPE
          com.sap.portal.navigation.ShowType.
static String ATTRIBUTE_SORT_PRIORITY
          com.sap.portal.navigation.Priority.
static String ATTRIBUTE_WIN_FEATURES
          com.sapportals.portal.navigation.WinFeatures.
static String ATTRIBUTE_WINHEIGHT
          com.sap.portal.navigation.ExtWindowHeight.
static String ATTRIBUTE_WINNAME
          com.sap.portal.navigation.WindowName.
static String ATTRIBUTE_WINWIDTH
          com.sap.portal.navigation.ExtWindowWidth.
 
Fields inherited from interface com.sap.portal.pcm.attributes.IAttrPcmLaunch
ATTRIBUTE_ALLOW_BROWSER, ATTRIBUTE_AUTH_SCHEME, ATTRIBUTE_CACHING_LEVEL, ATTRIBUTE_CODE_LINK, ATTRIBUTE_CONNECTION_POINT, ATTRIBUTE_PROPERTIES_URL, ATTRIBUTE_REFRESH_CONTENT, ATTRIBUTE_SUPPORTED_USER_AGENT, ATTRIBUTE_UNSUPPORTED_USER_AGENT, ATTRIBUTE_VALIDITY_PERIOD, VIRTUAL_RESOURCE_BUNDLE_PREFIX
 
Fields inherited from interface com.sap.portal.pcm.attributes.IAttrPcmGeneral
ATTRIBUTE_BUTTONS_URL, ATTRIBUTE_CATEGORY_NAME, ATTRIBUTE_COMPONENT_TYPE, ATTRIBUTE_DESCR, ATTRIBUTE_EDITOR_URL, ATTRIBUTE_EMBED_PROPERTY_EDITOR, ATTRIBUTE_HELP_URL, ATTRIBUTE_ICON_NAME, ATTRIBUTE_IS_TEMPLATE, ATTRIBUTE_SHOW_BUTTONS_TOOLBAR, ATTRIBUTE_TITLE, ATTRIBUTE_WIZARD_URL, META_ATTRIBUTE_ADMINISTRATION, META_ATTRIBUTE_CATEGORY, META_ATTRIBUTE_CATEGORY_ID, META_ATTRIBUTE_DESCRIPTION, META_ATTRIBUTE_INHERITANCE, META_ATTRIBUTE_LONG_DESCRIPTION, META_ATTRIBUTE_MANDATORY, META_ATTRIBUTE_MULTIVALUE, META_ATTRIBUTE_PERSONALIZATION, META_ATTRIBUTE_PLAIN_DESCRIPTION, META_ATTRIBUTE_TYPE, META_ATTRIBUTE_VALID_VALUE_TITLE, META_ATTRIBUTE_VALID_VALUES, PORTAL_PREFIX, PROPERTY_EDITOR_PREFIX, PUBLIC_PREFIX_IVIEW, PUBLIC_PREFIX_PCM, RESERVED_PREFIX_IVIEW
 

Field Detail

ATTRIBUTE_WINHEIGHT

public static final String ATTRIBUTE_WINHEIGHT
com.sap.portal.navigation.ExtWindowHeight.
type: Integer
plainDescription: Height of External Window (Pixels)
longDescription: Height (in pixels) of the external window that is displayed, showing the results of a drag event. Relevant only if 'Launch In' is set to 'External Window'.

See Also:
Constant Field Values

ATTRIBUTE_WINWIDTH

public static final String ATTRIBUTE_WINWIDTH
com.sap.portal.navigation.ExtWindowWidth.
type: Integer
plainDescription: Width of External Window (Pixels)
longDescription: Width of the external window that is displayed, showing results of a drag event. Relevant only if 'Launch In' is set to 'External Window'.

See Also:
Constant Field Values

ATTRIBUTE_WINNAME

public static final String ATTRIBUTE_WINNAME
com.sap.portal.navigation.WindowName.
type: String
plainDescription: Name of External Window
longDescription: Defines the HTML ID of the external window that is launched when a navigation node is chosen or a Drag and Relate event is triggered. It enables subsequent events to use the same external window rather than creating a new external window for each event. Relevant when 'Launch In' is set to 'External Window'.

See Also:
Constant Field Values

ATTRIBUTE_SHOWTYPE

public static final String ATTRIBUTE_SHOWTYPE
com.sap.portal.navigation.ShowType.
type: Integer
plainDescription: Launch In
longDescription: Defines where the contents of a navigation node or the results of a Drag and Relate event are displayed. 0=display in portal content area;1=display in external window.
valid values: 0, 1

See Also:
Constant Field Values

ATTRIBUTE_MERGEPRIO

public static final String ATTRIBUTE_MERGEPRIO
Deprecated. As of NW04 SP13, replaced by ATTRIBUTE_SORT_PRIORITY.

See Also:
Constant Field Values

ATTRIBUTE_SORT_PRIORITY

public static final String ATTRIBUTE_SORT_PRIORITY
com.sap.portal.navigation.Priority.
type: Double
plainDescription: Sort Priority
longDescription: Priority for sorting the display of navigation entry points and folders. Nodes are displayed in ascending order; lowest numbers are displayed first.

See Also:
Constant Field Values

ATTRIBUTE_MERGEID

public static final String ATTRIBUTE_MERGEID
com.sap.portal.navigation.MergeId.
type: String
plainDescription: Merge ID
longDescription: Optional, unique identifier reserved for objects that can merge their content, such as worksets and folders. For example, worksets and folders with the same Merge ID are merged as a single navigation node. Relevant only when 'Can be Merged' = true.

See Also:
Constant Field Values

ATTRIBUTE_DRAGRELATE

public static final String ATTRIBUTE_DRAGRELATE
com.sap.portal.navigation.DragRelate.
type: Integer
plainDescription: Drag and Relate Target
longDescription: Determines if the iView/page is a Drag and Relate target (a node that can receive a drag event). 0=No; 1=Yes.
valid values: 0, 1

See Also:
Constant Field Values

ATTRIBUTE_MERGIBLE

public static final String ATTRIBUTE_MERGIBLE
com.sap.portal.navigation.Mergible.
type: Boolean
plainDescription: Can be Merged
longDescription: Defines if a workset or folder can be merged with another navigation node with the same 'Merge ID'
valid values: true, false

See Also:
Constant Field Values

ATTRIBUTE_LAUNCHABLE

public static final String ATTRIBUTE_LAUNCHABLE
com.sap.portal.navigation.Launchable.
type: Boolean
valid values: true, false

See Also:
Constant Field Values

ATTRIBUTE_NAVINVISIBLE

public static final String ATTRIBUTE_NAVINVISIBLE
com.sap.portal.navigation.Invisible.
type: Boolean
valid values: true, false

See Also:
Constant Field Values

ATTRIBUTE_JSCRIPT

public static final String ATTRIBUTE_JSCRIPT
com.sap.portal.navigation.JScript.
type: String

See Also:
Constant Field Values

ATTRIBUTE_ENTRY_POINT

public static final String ATTRIBUTE_ENTRY_POINT
com.sap.portal.pcd.role.EntryPoint.
type: String

See Also:
Constant Field Values

ATTRIBUTE_ADD_TO_FAVORITES

public static final String ATTRIBUTE_ADD_TO_FAVORITES
com.sap.portal.navigation.ShowAddToFavorites.
type: String
plainDescription: Show 'Add to Favorites' Option
longDescription: Shows or hides the 'Add to Favorites' Option in the iview/page dropdown
valid values: true, false

See Also:
Constant Field Values

ATTRIBUTE_WIN_FEATURES

public static final String ATTRIBUTE_WIN_FEATURES
com.sapportals.portal.navigation.WinFeatures.
type: String
plainDescription: Window Features
longDescription: Specifies the appearance of the new window launched by an iView whose 'Launch In' property is set to '1'. Enter a comma-separated list of JavaScript parameters; for example: 'fullscreen=yes, toolbar=yes'. If empty, the new window opens according to default JavaScript parameters
valid values:

See Also:
Constant Field Values

ATTRIBUTE_PICTOGRAM

public static final String ATTRIBUTE_PICTOGRAM
com.sapportals.portal.navigation.Pictogram.
type: String
plainDescription: Workset Map Pictogram
longDescription: Specifies a pictogram (miniature picture) representing an iView/page/folder entry in a workset map page. Enter the full path and name of the pictogram file. See the documentation for complete details on workset pages

See Also:
Constant Field Values

ATTRIBUTE_FOLDER_ENTRY

public static final String ATTRIBUTE_FOLDER_ENTRY
com.sapportals.portal.navigation.FolderEntry.
type: String
plainDescription: Default Entry for Folder
longDescription: A page and iView property defining the object that displays by default when its folder is launched. The default value is 'False'. When there are multiple 'True' objects, the first one in the role structure is the default entry
valid values: true, false

See Also:
Constant Field Values

ATTRIBUTE_MERGE_PRIORITY

public static final String ATTRIBUTE_MERGE_PRIORITY
com.sap.portal.navigation.MergePriority.
type: Double
plainDescription: Merge Priority Assigns a number priority to navigation nodes. During merging of nodes, the node with the higher priority (lower number?) determines the name of the merged group and the sort order of the entries within the group
valid values: true, false

See Also:
Constant Field Values


Copyright 2006 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. MaxDB is a trademark of MySQL AB, Sweden. SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary. These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.