com.sap.portal.pcm.attributes

Interface IAttrPcmNavigation

All Superinterfaces:

IAttrPcmGeneral, IAttrPcmLaunch

All Known Subinterfaces:

IAttriView, IAttrPage

public interface IAttrPcmNavigation
extends IAttrPcmLaunch

An interface that defines constants for navigation-related attribute names.

Field Summary

static String	ATTRIBUTE_ADD_TO_FAVORITES Indicates whether the Add to Favorites option is visible in the iView/page tray.
static String	ATTRIBUTE_DRAGRELATE Indicates whether the iView/page is a Drag&Relate target.
static String	ATTRIBUTE_ENTRY_POINT Indicates if the object is displayed as a navigational entry point.
static String	ATTRIBUTE_FOLDER_ENTRY Sets the object that displays by default when its folder is launched.
static String	ATTRIBUTE_IS_LEAF Indicates whether the attribute is a leaf.
static String	ATTRIBUTE_JSCRIPT Drag&Relate JavaScript.
static String	ATTRIBUTE_LAUNCHABLE com.sap.portal.navigation.Launchable
static String	ATTRIBUTE_MERGE_PRIORITY Assigns a priority number to navigation nodes.
static String	ATTRIBUTE_MERGEID Optional, unique identifier reserved for objects that can merge their content.
static String	ATTRIBUTE_MERGEPRIO Deprecated. As of NW04 SP13, replaced by ATTRIBUTE_SORT_PRIORITY.
static String	ATTRIBUTE_MERGIBLE Indicates whether a workset or folder can be merged with another navigation node with the same ATTRIBUTE_MERGEID.
static String	ATTRIBUTE_NAVINVISIBLE Indicates whether the object is visible or hidden in the standard navigation iViews.
static String	ATTRIBUTE_PICTOGRAM Specifies a pictogram (mini graphic) representing an iView/page/folder entry in a workset map page.
static String	ATTRIBUTE_SHOWTYPE Defines where the contents of a navigation node or the results of a Drag&Relate event are displayed.
static String	ATTRIBUTE_SORT_PRIORITY Sets the priority for sorting the display of navigation entry points and folders.
static String	ATTRIBUTE_WIN_FEATURES Specifies the appearance of a new window launched as an external window.
static String	ATTRIBUTE_WINHEIGHT Sets the height (in pixels) of the external window that is displayed when showing the results of a drag event.
static String	ATTRIBUTE_WINNAME Sets the HTML ID of the external window that is launched when a navigation node is chosen or a Drag&Relate event is triggered.
static String	ATTRIBUTE_WINWIDTH Sets the width of the external window (in pixels) that is displayed when showing the results of a drag event.

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_EXT_LINK, 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_APPLICATION_CATEGORY, 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, PORTAL_SYSTEM, PROPERTY_EDITOR_PREFIX, PUBLIC_PREFIX_IVIEW, PUBLIC_PREFIX_PCM, RESERVED_PREFIX_IVIEW

Field Detail

ATTRIBUTE_WINHEIGHT

static final String ATTRIBUTE_WINHEIGHT

Sets the height (in pixels) of the external window that is displayed when showing the results of a drag event. Relevant only when ATTRIBUTE_SHOWTYPE is set to display in an external window.
The default is 750.
com.sap.portal.navigation.ExtWindowHeight

See Also:

Constant Field Values

ATTRIBUTE_WINWIDTH

static final String ATTRIBUTE_WINWIDTH

Sets the width of the external window (in pixels) that is displayed when showing the results of a drag event. Relevant only when ATTRIBUTE_SHOWTYPE is set to display in an external window.
The default is 500.
com.sap.portal.navigation.ExtWindowWidth

See Also:

Constant Field Values

ATTRIBUTE_WINNAME

static final String ATTRIBUTE_WINNAME

Sets the HTML ID of the external window that is launched when a navigation node is chosen or a Drag&Relate event is triggered. It enables subsequent events to use the same external window rather than creating a new external window for each event. This is relevant only when ATTRIBUTE_SHOWTYPE is set to display in an external window.
The valid values are: any string name
com.sap.portal.navigation.WindowName

See Also:

Constant Field Values

ATTRIBUTE_SHOWTYPE

static final String ATTRIBUTE_SHOWTYPE

Defines where the contents of a navigation node or the results of a Drag&Relate event are displayed.
The valid values are: 0 (display in portal content area), 1 (display in external window)
com.sap.portal.navigation.ShowType

See Also:

Constant Field Values

ATTRIBUTE_MERGEPRIO

static final String ATTRIBUTE_MERGEPRIO

Deprecated. As of NW04 SP13, replaced by ATTRIBUTE_SORT_PRIORITY.

com.sap.portal.navigation.Priority

See Also:

Constant Field Values

ATTRIBUTE_SORT_PRIORITY

static final String ATTRIBUTE_SORT_PRIORITY

Sets the priority for sorting the display of navigation entry points and folders. Nodes are displayed in ascending order; the lowest numbers are displayed first.
The default is 100.
The valid values are: 0-100
com.sap.portal.navigation.Priority

See Also:

Constant Field Values

ATTRIBUTE_MERGEID

static final String ATTRIBUTE_MERGEID

Optional, unique identifier reserved for objects that can merge their content. For example, worksets and folders with the same merge ID are merged into a single navigation node.
This is only relevant when ATTRIBUTE_MERGIBLE is set to true.
The valid values are: any string value
com.sap.portal.navigation.MergeId

See Also:

Constant Field Values

ATTRIBUTE_DRAGRELATE

static final String ATTRIBUTE_DRAGRELATE

Indicates whether the iView/page is a Drag&Relate target. A Drag&Relate target is a node that can receive a drag event.
The valid values are: 0 (enabled), 1 (disabled)
com.sap.portal.navigation.DragRelate

See Also:

Constant Field Values

ATTRIBUTE_MERGIBLE

static final String ATTRIBUTE_MERGIBLE

Indicates whether a workset or folder can be merged with another navigation node with the same ATTRIBUTE_MERGEID.
The valid values: true, false
com.sap.portal.navigation.Mergible

See Also:

Constant Field Values

ATTRIBUTE_LAUNCHABLE

static final String ATTRIBUTE_LAUNCHABLE

com.sap.portal.navigation.Launchable

See Also:

Constant Field Values

ATTRIBUTE_NAVINVISIBLE

static final String ATTRIBUTE_NAVINVISIBLE

Indicates whether the object is visible or hidden in the standard navigation iViews. Standard navigation iViews include top-level navigation and detailed navigation. The object is still accessible from other types of navigation iViews.
The valid values are: true (visible), false (hidden).
com.sap.portal.navigation.Invisible

See Also:

Constant Field Values

ATTRIBUTE_JSCRIPT

static final String ATTRIBUTE_JSCRIPT

Drag&Relate JavaScript.
com.sap.portal.navigation.JScript

See Also:

Constant Field Values

ATTRIBUTE_ENTRY_POINT

static final String ATTRIBUTE_ENTRY_POINT

Indicates if the object is displayed as a navigational entry point.
The valid values are: true, false.
com.sap.portal.pcd.role.EntryPoint

See Also:

Constant Field Values

ATTRIBUTE_ADD_TO_FAVORITES

static final String ATTRIBUTE_ADD_TO_FAVORITES

Indicates whether the Add to Favorites option is visible in the iView/page tray.
The valid values are: true (visible), false (hidden)
com.sap.portal.navigation.ShowAddToFavorites

See Also:

Constant Field Values

ATTRIBUTE_WIN_FEATURES

static final String ATTRIBUTE_WIN_FEATURES

Specifies the appearance of a new window launched as an external window. Enter a comma-separated list of JavaScript parameters.
For example: 'fullscreen=yes, toolbar=yes'.
If this attribute is empty, the new window opens according to the default JavaScript parameters.
com.sapportals.portal.navigation.WinFeatures

See Also:

Constant Field Values

ATTRIBUTE_PICTOGRAM

static final String ATTRIBUTE_PICTOGRAM

Specifies a pictogram (mini graphic) representing an iView/page/folder entry in a workset map page. Enter the full path for the pictogram file.
com.sapportals.portal.navigation.Pictogram

See Also:

Constant Field Values

ATTRIBUTE_FOLDER_ENTRY

static final String ATTRIBUTE_FOLDER_ENTRY

Sets the object that displays by default when its folder is launched. When there are multiple objects set to true, the first one in the role structure becomes the default entry.
The valid values are: true, false (default)
com.sapportals.portal.navigation.FolderEntry

See Also:

Constant Field Values

ATTRIBUTE_MERGE_PRIORITY

static final String ATTRIBUTE_MERGE_PRIORITY

Assigns a priority number 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.
com.sap.portal.navigation.MergePriority

See Also:

Constant Field Values

ATTRIBUTE_IS_LEAF

static final String ATTRIBUTE_IS_LEAF

Indicates whether the attribute is a leaf.
The valid values are: true, false

See Also:

Constant Field Values

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM
[sap.com] EP-RUNTIME	[sap.com] tc/ep/semantics/api	api	EP-PIN