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 java.lang.String	ATTRIBUTE_ADD_TO_FAVORITES Constant for the attribute name: 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
static java.lang.String	ATTRIBUTE_DRAGRELATE Constant for the attribute name: com.sap.portal.navigation.DragRelate type: Integer plainDescription: Drag&Relate Target longDescription: Determines if the iView/page is a Drag&Relate target (a node that can receive a drag event). 0=No; 1=Yes.
static java.lang.String	ATTRIBUTE_ENTRY_POINT Constant for the attribute name: com.sap.portal.pcd.role.EntryPoint type: String plainDescription: longDescription: valid values:
static java.lang.String	ATTRIBUTE_FOLDER_ENTRY Constant for the attribute name: 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.
static java.lang.String	ATTRIBUTE_JSCRIPT Constant for the attribute name: com.sap.portal.navigation.JScript type: String plainDescription: longDescription: valid values:
static java.lang.String	ATTRIBUTE_LAUNCHABLE
static java.lang.String	ATTRIBUTE_MERGE_PRIORITY Constant for the attribute name: com.sap.portal.navigation.MergePriority type: Double plainDescription: Merge Priority Assigns a number priority to navigation nodes.
static java.lang.String	ATTRIBUTE_MERGEID Constant for the attribute name: 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.
static java.lang.String	ATTRIBUTE_MERGEPRIO Deprecated. use ATTRIBUTE_SORT_PRIORITY instead
static java.lang.String	ATTRIBUTE_MERGIBLE Constant for the attribute name: 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
static java.lang.String	ATTRIBUTE_NAVINVISIBLE Constant for the attribute name: com.sap.portal.navigation.Invisible type: Boolean plainDescription: longDescription: valid values: true, false
static java.lang.String	ATTRIBUTE_PICTOGRAM Constant for the attribute name: 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.
static java.lang.String	ATTRIBUTE_SHOWTYPE Constant for the attribute name: 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&Relate event are displayed. 0=display in portal content area;1=display in external window.
static java.lang.String	ATTRIBUTE_SORT_PRIORITY Constant for the attribute name: com.sap.portal.navigation.Priority type: Double plainDescription: Sort Priority longDescription: Priority for sorting the display of navigation entry points and folders.
static java.lang.String	ATTRIBUTE_WIN_FEATURES Constant for the attribute name: 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'.
static java.lang.String	ATTRIBUTE_WINHEIGHT Constant for the attribute name: 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.
static java.lang.String	ATTRIBUTE_WINNAME Constant for the attribute name: 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&Relate event is triggered.
static java.lang.String	ATTRIBUTE_WINWIDTH Constant for the attribute name: 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.

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 java.lang.String ATTRIBUTE_WINHEIGHT

Constant for the attribute name:
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'.
valid values:

ATTRIBUTE_WINWIDTH

public static final java.lang.String ATTRIBUTE_WINWIDTH

Constant for the attribute name:
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'.
valid values:

ATTRIBUTE_WINNAME

public static final java.lang.String ATTRIBUTE_WINNAME

Constant for the attribute name:
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&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'.
valid values:

ATTRIBUTE_SHOWTYPE

public static final java.lang.String ATTRIBUTE_SHOWTYPE

Constant for the attribute name:
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&Relate event are displayed. 0=display in portal content area;1=display in external window.
valid values: 0, 1

ATTRIBUTE_MERGEPRIO

public static final java.lang.String ATTRIBUTE_MERGEPRIO

Deprecated. use ATTRIBUTE_SORT_PRIORITY instead

ATTRIBUTE_SORT_PRIORITY

public static final java.lang.String ATTRIBUTE_SORT_PRIORITY

Constant for the attribute name:
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.
valid values:

ATTRIBUTE_MERGEID

public static final java.lang.String ATTRIBUTE_MERGEID

Constant for the attribute name:
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.
valid values:

ATTRIBUTE_DRAGRELATE

public static final java.lang.String ATTRIBUTE_DRAGRELATE

Constant for the attribute name:
com.sap.portal.navigation.DragRelate
type: Integer
plainDescription: Drag&Relate Target
longDescription: Determines if the iView/page is a Drag&Relate target (a node that can receive a drag event). 0=No; 1=Yes.
valid values: 0, 1

ATTRIBUTE_MERGIBLE

public static final java.lang.String ATTRIBUTE_MERGIBLE

Constant for the attribute name:
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

ATTRIBUTE_LAUNCHABLE

public static final java.lang.String ATTRIBUTE_LAUNCHABLE

ATTRIBUTE_NAVINVISIBLE

public static final java.lang.String ATTRIBUTE_NAVINVISIBLE

Constant for the attribute name:
com.sap.portal.navigation.Invisible
type: Boolean
plainDescription:
longDescription:
valid values: true, false

ATTRIBUTE_JSCRIPT

public static final java.lang.String ATTRIBUTE_JSCRIPT

Constant for the attribute name:
com.sap.portal.navigation.JScript
type: String
plainDescription:
longDescription:
valid values:

ATTRIBUTE_ENTRY_POINT

public static final java.lang.String ATTRIBUTE_ENTRY_POINT

Constant for the attribute name:
com.sap.portal.pcd.role.EntryPoint
type: String
plainDescription:
longDescription:
valid values:

ATTRIBUTE_ADD_TO_FAVORITES

public static final java.lang.String ATTRIBUTE_ADD_TO_FAVORITES

Constant for the attribute name:
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

ATTRIBUTE_WIN_FEATURES

public static final java.lang.String ATTRIBUTE_WIN_FEATURES

Constant for the attribute name:
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:

ATTRIBUTE_PICTOGRAM

public static final java.lang.String ATTRIBUTE_PICTOGRAM

Constant for the attribute name:
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
valid values:

ATTRIBUTE_FOLDER_ENTRY

public static final java.lang.String ATTRIBUTE_FOLDER_ENTRY

Constant for the attribute name:
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

ATTRIBUTE_MERGE_PRIORITY

public static final java.lang.String ATTRIBUTE_MERGE_PRIORITY

Constant for the attribute name:
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