public abstract class AbstractBrowserArea extends java.lang.Object implements UIBrowserArea
| Modifier and Type | Class and Description |
|---|---|
protected class |
AbstractBrowserArea.MySessionListener |
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
BROWSER_TAB_COMPONENT |
protected java.util.List<BrowserModel> |
browsers |
protected static java.lang.String |
COCKPIT_ID_BROWSERAREA_TAB_PREFIX |
protected java.util.Map<BrowserModel,AbstractContentBrowser> |
componentMap |
static java.lang.String |
INFO_AREA_CONTAINER |
protected boolean |
initialized |
protected UISessionListener |
mySessionListener |
static java.lang.String |
RESULT_GRID_RENDERER |
protected java.util.List<BrowserModel> |
visibleBrowsers |
| Constructor and Description |
|---|
AbstractBrowserArea() |
| Modifier and Type | Method and Description |
|---|---|
protected boolean |
addBrowser(BrowserModel browserModel)
Adds the
BrowserModel b if not already added, registers this AbstractBrowserArea
instance as BrowserModelListener and calls b.setArea(this) . |
protected boolean |
addBrowser(int index,
BrowserModel browserModel) |
void |
addBrowserAreaListener(BrowserAreaListener listener) |
void |
addCockpitEventAcceptor(CockpitEventAcceptor acceptor) |
boolean |
addHiddenBrowser(BrowserModel browserModel)
Adds the
BrowserModel b if not already added, registers this AbstractBrowserArea
instance as BrowserModelListener, calls b.setArea(this) and
removes b from the visible browsers if possible i.e. |
boolean |
addVisibleBrowser(BrowserModel browserModel)
Same as
addVisibleBrowser(b, false). |
boolean |
addVisibleBrowser(BrowserModel browserModel,
boolean replaceInactive)
Deprecated.
since 6.3, use
addVisibleBrowser(BrowserModel) Adds the
BrowserModel b, if not already added, to the visible browsers, registers this
AbstractBrowserArea instance as BrowserModelListener and calls
b.setArea(this). if replaceInactive is
true a BrowserModel which has no focus will be replaced i.e. it will be minimized
and b will take its place. If calling this method causes browsers to be added, opened or
minimized any registered BrowserAreaListeners will be notified.
Note: This method will not reset the view so you might want to call update(). |
boolean |
addVisibleBrowser(int index,
BrowserModel browserModel) |
protected void |
checkShowInspector(LayoutRegion parentRegion,
ListProvider<TypedObject> listProvider) |
protected void |
checkShowInspector(LayoutRegion parentRegion,
ListProvider<TypedObject> listProvider,
boolean closeEditor) |
void |
close(BrowserModel browserModel) |
void |
closeInspector()
Tries to close inspector area if present.
|
void |
closeInspector(java.lang.String divId)
Tries to close inspector area if present.
|
protected void |
closeInspectorInComponent(Component infoArea) |
void |
closeOthers(BrowserModel browserModel) |
java.lang.String |
computeTabLabel(java.lang.String label) |
protected void |
createAndAddTabPopup(Tab tab,
BrowserModel browserModel) |
protected Component |
createBrowserView(Borderlayout parent,
BrowserModel browserModel) |
BrowserModel |
createNewDefaultBrowser()
Creates a new default browser model for this area
|
void |
duplicateBrowser(BrowserModel browserModel)
Creates a new
BrowserModel instance by cloning b and adds it to the "visible"
browsers, thus potentially causing a previously visible browser to be minimized (since there is a limit to how
many browsers can be visible at the same time). |
protected void |
fireBrowserAdded(BrowserModel browserModel) |
protected void |
fireBrowserChanged(BrowserModel browserModel) |
protected void |
fireBrowserClosed(BrowserModel browserModel) |
protected void |
fireBrowserFocused(BrowserModel browserModel) |
protected void |
fireBrowserMinimized(BrowserModel browserModel) |
protected void |
fireBrowserOpened(BrowserModel browserModel) |
protected void |
fireBrowserQuerySaved(BrowserModel browserModel) |
protected void |
fireBrowsersClosed(java.util.List<BrowserModel> browsers) |
protected void |
fireItemActivated(TypedObject activeItem) |
protected void |
fireItemsDropped(BrowserModel browser,
java.util.Collection<TypedObject> items) |
protected void |
fireSelectionChanged(BrowserModel browserModel) |
protected void |
fireSplitmodeChanged() |
ActionColumnConfiguration |
getAdditionalToolbarActions() |
java.util.Set<BrowserAreaListener> |
getBrowserAreaListeners() |
abstract BrowserModelListener |
getBrowserListener() |
java.util.List<BrowserModel> |
getBrowsers() |
protected AbstractComponent |
getContainerComponent() |
AbstractContentBrowser |
getCorrespondingContentBrowser(BrowserModel browserModel) |
java.lang.String |
getDefaultBrowserClass() |
java.util.Map<java.lang.String,java.lang.String> |
getDefaultBrowserViewMapping() |
BrowserModel |
getFocusedBrowser() |
java.util.List<BrowserModel> |
getHiddenBrowsers() |
Component |
getInfoArea() |
Component |
getInfoArea(java.lang.String divId) |
protected java.lang.String |
getInfoAreaContainerId() |
protected InspectorRenderer |
getInspectorRenderer() |
java.lang.String |
getLabel() |
UICockpitPerspective |
getManagingPerspective() |
ActionColumnConfiguration |
getMultiSelectActions() |
ActionColumnConfiguration |
getMultiSelectContextActions() |
ContextAreaActionColumnConfigurationRegistry |
getMultiSelectContextActionsRegistry() |
UICockpitPerspective |
getPerspective() |
BrowserModel |
getPreviousBrowser() |
java.lang.String |
getViewURI() |
java.util.List<BrowserModel> |
getVisibleBrowsers() |
void |
hide(BrowserModel browserModel)
Convenience method for hiding a
BrowserModel. |
void |
initBrowsers(Borderlayout container) |
void |
initialize(java.util.Map<java.lang.String,java.lang.Object> params) |
boolean |
isBrowserMinimized(BrowserModel browserModel)
Returns whether the
BrowserModel b is minimized (hidden) or not. |
boolean |
isClosable(BrowserModel browserModel) |
boolean |
isFocused() |
protected boolean |
isInfoAreaOpen() |
boolean |
isMinimizable(BrowserModel browserModel) |
boolean |
isOpenInspectorOnSelect() |
boolean |
isPossibleAddContextSubTypes() |
boolean |
isSaveQueryAvailable() |
protected boolean |
isShowAsClosable(BrowserModel browserModel) |
boolean |
isShowCreateDefaultBrowserButton() |
boolean |
isSplitModeActive() |
boolean |
isSplittable() |
void |
onCockpitEvent(CockpitEvent event) |
void |
openInspector(TypedObject item)
Tries to open the inspector area if present.
|
protected void |
openInspectorInArea(TypedObject item,
Component infoArea) |
void |
openInspectorInDiv(TypedObject item,
java.lang.String divId) |
boolean |
providesDefaultBrowser() |
protected boolean |
removeBrowser(BrowserModel browser)
Removes the
BrowserModel b, de-registers this AbstractBrowserArea instance as
BrowserModelListener, calls b.setArea(null) and removes
b from the visible browsers (if present). |
void |
removeBrowserAreaListener(BrowserAreaListener listener) |
void |
removeCockpitEventAcceptor(CockpitEventAcceptor acceptor) |
void |
replaceBrowser(BrowserModel oldBrowser,
BrowserModel newBrowser)
Replaces
oldBrowser with newBrowser i.e. |
void |
replaceBrowser(int index,
BrowserModel newBrowser)
Replaces the visible browser with index
index with newBrowser. |
protected void |
resetBrowserView(BrowserModel browserModel) |
void |
setAdditionalToolbarActions(ActionColumnConfiguration additionalToolbarActions) |
void |
setDefaultBrowserClass(java.lang.String defaultBrowserClass) |
void |
setDefaultBrowserViewMapping(java.util.Map<java.lang.String,java.lang.String> defaultBrowserViewMapping) |
void |
setFocus(boolean focus) |
void |
setFocusedBrowser(BrowserModel browserModel) |
void |
setInfoAreaContainerId(java.lang.String infoAreaContainerId) |
void |
setInspectorRenderer(InspectorRenderer inspectorRenderer) |
void |
setMultiSelectActions(ActionColumnConfiguration multiSelectActions) |
void |
setMultiSelectContextActions(ActionColumnConfiguration multiSelectContextActions) |
void |
setMultiSelectContextActionsRegistry(ContextAreaActionColumnConfigurationRegistry multiSelectContextActionsRegistry) |
void |
setOpenInspectorOnSelect(boolean openInspectorOnSelect) |
void |
setPerspective(UICockpitPerspective perspective) |
void |
setPossibleAddContextSubTypes(boolean possibleAddContextSubTypes) |
void |
setShowCreateDefaultBrowserButton(boolean showCreateDefaultBrowserButton) |
void |
setSplitModeActive(boolean splitmodeActivated) |
void |
setSplitModeActiveDirectly(boolean splitmodeActivated) |
void |
setSplittable(boolean splittable) |
void |
setViewURI(java.lang.String viewURI) |
void |
show(BrowserModel browserModel)
Convenience method for displaying a
BrowserModel. |
void |
update()
Resets the view i.e.
|
void |
updateActivation(BrowserModel browserModel)
This method makes it possible to force the view to get the currently active item(s) from its model i.e.
|
void |
updateActiveItems() |
void |
updateInfoArea(ListProvider<TypedObject> listProvider) |
void |
updateInfoArea(ListProvider<TypedObject> listProvider,
boolean handleVisibility) |
void |
updateSelectedItems(BrowserModel browserModel) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitsaveQuerypublic static final java.lang.String INFO_AREA_CONTAINER
public static final java.lang.String RESULT_GRID_RENDERER
public static final java.lang.String BROWSER_TAB_COMPONENT
protected final java.util.List<BrowserModel> browsers
protected final java.util.List<BrowserModel> visibleBrowsers
protected final UISessionListener mySessionListener
protected final transient java.util.Map<BrowserModel,AbstractContentBrowser> componentMap
protected boolean initialized
protected static final java.lang.String COCKPIT_ID_BROWSERAREA_TAB_PREFIX
public boolean isSaveQueryAvailable()
isSaveQueryAvailable in interface UIBrowserAreapublic java.lang.String getViewURI()
getViewURI in interface UIComponentpublic void setViewURI(java.lang.String viewURI)
public java.util.Set<BrowserAreaListener> getBrowserAreaListeners()
public void initialize(java.util.Map<java.lang.String,java.lang.Object> params)
initialize in interface UICockpitAreainitialize in interface UIComponentpublic Component getInfoArea()
protected java.lang.String getInfoAreaContainerId()
public Component getInfoArea(java.lang.String divId)
public void openInspector(TypedObject item)
item - You can specify an item that should be rendered in the inspector. If you just want to show the area,
pass null.public void openInspectorInDiv(TypedObject item, java.lang.String divId)
protected void openInspectorInArea(TypedObject item, Component infoArea)
public void closeInspector()
protected void closeInspectorInComponent(Component infoArea)
public void closeInspector(java.lang.String divId)
public void updateInfoArea(ListProvider<TypedObject> listProvider)
public void updateInfoArea(ListProvider<TypedObject> listProvider, boolean handleVisibility)
protected void checkShowInspector(LayoutRegion parentRegion,
ListProvider<TypedObject> listProvider)
protected void checkShowInspector(LayoutRegion parentRegion,
ListProvider<TypedObject> listProvider,
boolean closeEditor)
public void initBrowsers(Borderlayout container)
initBrowsers in interface UIBrowserAreapublic AbstractContentBrowser getCorrespondingContentBrowser(BrowserModel browserModel)
protected AbstractComponent getContainerComponent()
protected void resetBrowserView(BrowserModel browserModel)
public void updateActivation(BrowserModel browserModel)
updateActivation in interface UIBrowserAreaAbstractContentBrowser.updateActivation()public void update()
BrowserModel instances.update in interface UICockpitAreacreateBrowserView(Borderlayout, BrowserModel)protected void createAndAddTabPopup(Tab tab,
BrowserModel browserModel)
public BrowserModel createNewDefaultBrowser()
public boolean providesDefaultBrowser()
public java.lang.String computeTabLabel(java.lang.String label)
protected Component createBrowserView(Borderlayout parent,
BrowserModel browserModel)
public void updateSelectedItems(BrowserModel browserModel)
updateSelectedItems in interface UIBrowserAreapublic void updateActiveItems()
updateActiveItems in interface UIBrowserAreapublic void duplicateBrowser(BrowserModel browserModel)
BrowserModel instance by cloning b and adds it to the "visible"
browsers, thus potentially causing a previously visible browser to be minimized (since there is a limit to how
many browsers can be visible at the same time).
Calling this method will reset the view.duplicateBrowser in interface UIBrowserAreabrowserModel - the browser to be duplicated.update(),
BrowserModel.clone()public java.util.List<BrowserModel> getBrowsers()
getBrowsers in interface UIBrowserAreapublic java.util.List<BrowserModel> getVisibleBrowsers()
getVisibleBrowsers in interface UIBrowserAreapublic java.util.List<BrowserModel> getHiddenBrowsers()
public void hide(BrowserModel browserModel)
BrowserModel. Does the same thing as
addHiddenBrowser(b) with the addition that the remaining visible
BrowserModel gets focus and update() is called if necessary.hide in interface UIBrowserAreabrowserModel - the BrowserModel to hideaddHiddenBrowser(BrowserModel),
setFocusedBrowser(BrowserModel),
update()public void show(BrowserModel browserModel)
BrowserModel. Does the same thing as
addVisibleBrowser(b, true) with the addition that b
is given focus and update() is called if necessary.show in interface UIBrowserAreabrowserModel - the BrowserModel to showaddVisibleBrowser(BrowserModel, boolean),
setFocusedBrowser(BrowserModel),
update()public void close(BrowserModel browserModel)
close in interface UIBrowserAreapublic void closeOthers(BrowserModel browserModel)
closeOthers in interface UIBrowserAreapublic void replaceBrowser(BrowserModel oldBrowser, BrowserModel newBrowser)
oldBrowser with newBrowser i.e. closes oldBrowser and opens
newBrowser. If oldBrowser was focused newBrowser will get focus after
replacement has taken place.
Note: Calling this method will cause the view to be reset.replaceBrowser in interface UIBrowserAreaoldBrowser - the old browser which is to be closednewBrowser - the new browser which is to be openedupdate(),
setFocusedBrowser(BrowserModel),
addVisibleBrowser(BrowserModel),
removeBrowser(BrowserModel)public void replaceBrowser(int index,
BrowserModel newBrowser)
index with newBrowser.index - index of the visible browser to replacenewBrowser - the new browser which is to be openedpublic boolean isPossibleAddContextSubTypes()
public boolean isClosable(BrowserModel browserModel)
isClosable in interface UIBrowserAreapublic boolean isMinimizable(BrowserModel browserModel)
isMinimizable in interface UIBrowserAreapublic UICockpitPerspective getPerspective()
getPerspective in interface UICockpitAreapublic void setPerspective(UICockpitPerspective perspective)
setPerspective in interface UICockpitAreapublic void setFocusedBrowser(BrowserModel browserModel)
setFocusedBrowser in interface UIBrowserAreapublic BrowserModel getFocusedBrowser()
getFocusedBrowser in interface UIBrowserAreapublic boolean isBrowserMinimized(BrowserModel browserModel)
BrowserModel b is minimized (hidden) or not.isBrowserMinimized in interface UIBrowserAreabrowserModel - the BrowserModeltrue if b is minimized, false otherwisepublic void addBrowserAreaListener(BrowserAreaListener listener)
addBrowserAreaListener in interface UIBrowserAreapublic void removeBrowserAreaListener(BrowserAreaListener listener)
removeBrowserAreaListener in interface UIBrowserAreaprotected boolean addBrowser(BrowserModel browserModel)
BrowserModel b if not already added, registers this AbstractBrowserArea
instance as BrowserModelListener and calls b.setArea(this) .browserModel - the AbstractBrowser to addtrue if a new browser was added (i.e. if b was not previously present)protected boolean addBrowser(int index,
BrowserModel browserModel)
public BrowserModel getPreviousBrowser()
getPreviousBrowser in interface UIBrowserAreapublic boolean addHiddenBrowser(BrowserModel browserModel)
BrowserModel b if not already added, registers this AbstractBrowserArea
instance as BrowserModelListener, calls b.setArea(this) and
removes b from the visible browsers if possible i.e. if isMinimizable(b) returns true. If calling this method causes b to be minimized any
registered BrowserAreaListeners will be notified.
Note: This method will not reset the view so you might want to call update().browserModel - the AbstractBrowser to addtrue if the view needs to be updated due to changes madeaddBrowser(BrowserModel),
hide(BrowserModel)public boolean addVisibleBrowser(BrowserModel browserModel)
addVisibleBrowser(b, false).
Note: This method will not reset the view so you might want to call update().browserModel - the BrowserModel to addtrue if the view needs to be updated due to changes madeaddVisibleBrowser(BrowserModel, boolean),
update(),
show(BrowserModel)@Deprecated public boolean addVisibleBrowser(BrowserModel browserModel, boolean replaceInactive)
addVisibleBrowser(BrowserModel) Adds the
BrowserModel b, if not already added, to the visible browsers, registers this
AbstractBrowserArea instance as BrowserModelListener and calls
b.setArea(this). if replaceInactive is
true a BrowserModel which has no focus will be replaced i.e. it will be minimized
and b will take its place. If calling this method causes browsers to be added, opened or
minimized any registered BrowserAreaListeners will be notified.
Note: This method will not reset the view so you might want to call update().addVisibleBrowser in interface UIBrowserAreabrowserModel - the BrowserModel to addreplaceInactive - if true the BrowserModel which has no focus will be replaced with b ,
if false b will be inserted as the second browsertrue if the view needs to be updated due to changes madeaddBrowser(BrowserModel),
BrowserAreaListener.browserAdded(BrowserModel),
BrowserAreaListener.browserMinimized(BrowserModel),
BrowserAreaListener.browserOpened(BrowserModel),
update(),
show(BrowserModel)public boolean addVisibleBrowser(int index,
BrowserModel browserModel)
addVisibleBrowser in interface UIBrowserAreaprotected boolean removeBrowser(BrowserModel browser)
BrowserModel b, de-registers this AbstractBrowserArea instance as
BrowserModelListener, calls b.setArea(null) and removes
b from the visible browsers (if present). If b is null, nothing is done and
false is returned.browser - the BrowserModel to removetrue if the view needs to be updated due to the changes madeclose(BrowserModel)protected void fireSelectionChanged(BrowserModel browserModel)
protected void fireBrowserClosed(BrowserModel browserModel)
protected void fireBrowsersClosed(java.util.List<BrowserModel> browsers)
protected void fireBrowserMinimized(BrowserModel browserModel)
protected void fireBrowserOpened(BrowserModel browserModel)
protected void fireBrowserAdded(BrowserModel browserModel)
protected void fireBrowserChanged(BrowserModel browserModel)
protected void fireBrowserFocused(BrowserModel browserModel)
protected void fireBrowserQuerySaved(BrowserModel browserModel)
protected void fireSplitmodeChanged()
protected void fireItemActivated(TypedObject activeItem)
protected void fireItemsDropped(BrowserModel browser, java.util.Collection<TypedObject> items)
public UICockpitPerspective getManagingPerspective()
getManagingPerspective in interface FocusablePerspectiveAreapublic boolean isFocused()
isFocused in interface FocusablePerspectiveAreapublic void setPossibleAddContextSubTypes(boolean possibleAddContextSubTypes)
public void setFocus(boolean focus)
setFocus in interface FocusablePerspectiveAreapublic abstract BrowserModelListener getBrowserListener()
public void setSplitModeActiveDirectly(boolean splitmodeActivated)
public void setSplitModeActive(boolean splitmodeActivated)
setSplitModeActive in interface UIBrowserAreasplitmodeActivated - the splitmodeActivated to setpublic boolean isSplitModeActive()
isSplitModeActive in interface UIBrowserAreapublic void setSplittable(boolean splittable)
setSplittable in interface UIBrowserAreasplittable - the splittable to setpublic boolean isSplittable()
isSplittable in interface UIBrowserAreapublic void addCockpitEventAcceptor(CockpitEventAcceptor acceptor)
addCockpitEventAcceptor in interface CockpitEventProducerpublic void removeCockpitEventAcceptor(CockpitEventAcceptor acceptor)
removeCockpitEventAcceptor in interface CockpitEventProducerpublic void onCockpitEvent(CockpitEvent event)
onCockpitEvent in interface CockpitEventAcceptorprotected boolean isInfoAreaOpen()
public java.lang.String getLabel()
getLabel in interface UIComponentpublic void setMultiSelectActions(ActionColumnConfiguration multiSelectActions)
setMultiSelectActions in interface UIBrowserAreapublic ActionColumnConfiguration getMultiSelectActions()
getMultiSelectActions in interface UIBrowserAreapublic void setMultiSelectContextActions(ActionColumnConfiguration multiSelectContextActions)
setMultiSelectContextActions in interface UIBrowserAreapublic ActionColumnConfiguration getMultiSelectContextActions()
getMultiSelectContextActions in interface UIBrowserAreapublic void setMultiSelectContextActionsRegistry(ContextAreaActionColumnConfigurationRegistry multiSelectContextActionsRegistry)
setMultiSelectContextActionsRegistry in interface UIBrowserAreamultiSelectContextActionsRegistry - the multiSelectContextActionsRegistry to setpublic ContextAreaActionColumnConfigurationRegistry getMultiSelectContextActionsRegistry()
getMultiSelectContextActionsRegistry in interface UIBrowserAreapublic void setAdditionalToolbarActions(ActionColumnConfiguration additionalToolbarActions)
public ActionColumnConfiguration getAdditionalToolbarActions()
public java.util.Map<java.lang.String,java.lang.String> getDefaultBrowserViewMapping()
getDefaultBrowserViewMapping in interface UIBrowserAreapublic void setDefaultBrowserViewMapping(java.util.Map<java.lang.String,java.lang.String> defaultBrowserViewMapping)
public void setDefaultBrowserClass(java.lang.String defaultBrowserClass)
public java.lang.String getDefaultBrowserClass()
protected boolean isShowAsClosable(BrowserModel browserModel)
public void setShowCreateDefaultBrowserButton(boolean showCreateDefaultBrowserButton)
public boolean isShowCreateDefaultBrowserButton()
public void setInspectorRenderer(InspectorRenderer inspectorRenderer)
protected InspectorRenderer getInspectorRenderer()
public void setOpenInspectorOnSelect(boolean openInspectorOnSelect)
public boolean isOpenInspectorOnSelect()
public void setInfoAreaContainerId(java.lang.String infoAreaContainerId)
Copyright © 2018 SAP SE. All Rights Reserved.