com.sap.tc.webdynpro.progmodel.api

Interface IWDViewElement

All Known Subinterfaces:

IWDAbstractActiveComponent, IWDAbstractButton, IWDAbstractCaption, IWDAbstractDropDown, IWDAbstractDropDownByIndex, IWDAbstractDropDownByKey, IWDAbstractFlow, IWDAbstractIgsElement, IWDAbstractInputField, IWDAbstractLabeledRange, IWDAbstractMasterTableColumn, IWDAbstractPatternContainer, IWDAbstractPopin, IWDAbstractRange, IWDAbstractRangedSlider, IWDAbstractSeries, IWDAbstractSlider, IWDAbstractTableCellVariant, IWDAbstractTableColumn, IWDAbstractToggle, IWDAbstractToggleButton, IWDAbstractTreeNodeType, IWDAbstractTreeTableColumn, IWDAbstractValue, IWDAccordion, IWDAnalyticsChart, IWDBarCodeReader, IWDBIApplicationFrame, IWDBreadCrumb, IWDBreadCrumbStep, IWDBusinessGraphics, IWDButton, IWDButtonRow, IWDButtonRowItem, IWDCaption, IWDCategory, IWDCategoryAxis, IWDCheckBox, IWDCheckBoxGroup, IWDClock, IWDContextualPanel, IWDContextualPanelItem, IWDDataSeries, IWDDateNavigator, IWDDateNavigatorLegend, IWDDateNavigatorMarking, IWDDropDownByIndex, IWDDropDownByKey, IWDExpandableTitle, IWDFileDownload, IWDFileUpload, IWDFlowData, IWDFlowLayout, IWDFreeContextualArea, IWDFunctionKey, IWDGantt, IWDGauge, IWDGeoMap, IWDGridData, IWDGridLayout, IWDGroup, IWDHorizontalFlow, IWDHorizontalGutter, IWDHorizontalRange, IWDHorizontalSlider, IWDIFrame, IWDImage, IWDInputField, IWDInteractiveForm, IWDInvisibleElement, IWDItemListBox, IWDLabel, IWDLayout, IWDLayoutData, IWDLegend, IWDLegendItem, IWDLink, IWDLinkToAction, IWDLinkToURL, IWDMatrixData, IWDMatrixHeadData, IWDMatrixLayout, IWDMenu, IWDMenuActionItem, IWDMenuBar, IWDMenuCheckBox, IWDMenuItem, IWDMenuRadioButton, IWDMenuSeparator, IWDMessageArea, IWDMultipleBreadCrumbStep, IWDMultipleLegendItem, IWDMultiplePhase, IWDMultipleRoadMapStep, IWDNavigationList, IWDNetwork, IWDNumericValue, IWDOfficeControl, IWDPageHeader, IWDPageHeaderArea, IWDPane, IWDPatternContentArea, IWDPatternExpandFunction, IWDPatternSequence, IWDPatternSequenceStep, IWDPatternTab, IWDPatternTabStrip, IWDPatternTray, IWDPhase, IWDPhaseIndicator, IWDPoint, IWDPopin, IWDPortalIFrame, IWDPrintButton, IWDProgressIndicator, IWDRadioButton, IWDRadioButtonGroupByIndex, IWDRadioButtonGroupByKey, IWDRFIDReader, IWDRoadMap, IWDRoadMapStep, IWDRowData, IWDRowHeadData, IWDRowLayout, IWDScrollContainer, IWDSeries, IWDSimpleSeries, IWDSpinner, IWDStroke, IWDTab, IWDTable, IWDTableCellEditor, IWDTableColumn, IWDTableColumnGroup, IWDTableMarkableCellEditor, IWDTablePopin, IWDTablePopinToggleCell, IWDTableSingleMarkableCell, IWDTableStandardCell, IWDTableSummaryCell, IWDTableSummaryHierarchyCell, IWDTabStrip, IWDTextBar, IWDTextEdit, IWDTextView, IWDTicker, IWDTimedTrigger, IWDTimeValue, IWDToggleButton, IWDToggleLink, IWDToolBar, IWDToolBarButton, IWDToolBarButtonChoice, IWDToolBarDropDownByIndex, IWDToolBarDropDownByKey, IWDToolBarInputField, IWDToolBarItem, IWDToolBarLinkToAction, IWDToolBarLinkToURL, IWDToolBarSeparator, IWDToolBarToggleButton, IWDTransparentContainer, IWDTray, IWDTree, IWDTreeByNestingTableColumn, IWDTreeItemType, IWDTreeNodeType, IWDTriStateCheckBox, IWDUIElement, IWDUIElementContainer, IWDValueComparison, IWDVerticalFlow, IWDVerticalGutter, IWDVerticalRange, IWDVerticalSlider, IWDViewContainer, IWDViewContainerUIElement, IWDViewSwitch, IWDWebDynproIViewArea

public interface IWDViewElement

Generic API of all view elements, visible or otherwise. This interface represents the lowest level of commonality that exists across all elements within a view. The resulting elements based on this interface do not necessarily correspond to elements visible on the client (for example, IWDFlowData). A view element knows its containing view and an ID that is unique within that view. This type can be called by applications using Web Dynpro, but DO NOT EXTEND OR IMPLEMENT IT!

Type Classification:

This interface is part of the Web Dynpro API, so applications may reference it or call any method of it, but they must not implement or extend it.

For a detailed explanation of API classification see the Web Dynpro Compatibility Guide

Method Summary

void	destroy() Destroys this view element by removing it from the containing view and from the containing parent.
String	getId() Returns the ID that uniquely identifies this view element within its containing view.
IWDView	getView() Returns the API of the containing view.
void	requestFocus() Requests to change the keyboard input focus to this view element.

Method Detail

getId

public String getId()

Returns the ID that uniquely identifies this view element within its containing view.

getView

public IWDView getView()

Returns the API of the containing view.

destroy

public void destroy()

Destroys this view element by removing it from the containing view and from the containing parent.

requestFocus

public void requestFocus()

Requests to change the keyboard input focus to this view element. It is undefined which focus request wins if there are several ones. The request may silently fail, but is guaranteed not to throw an exception. If this view element is a table cell editor, its occurence in the current row (according to the context's lead selection) will receive focus. Similar things will happen inside other containers that display multiple occurences of the same view element.