name
stringlengths
12
178
code_snippet
stringlengths
8
36.5k
score
float64
3.26
3.68
framework_VTabsheetBase_addTabKey_rdh
/** * For internal use only. May be removed or replaced in the future. * * @param key * an internal key that corresponds with a tab * @param disabled * {@code true} if the tab should be disabled, {@code false} * otherwise */ public void addTabKey(String key, boolean disabled) { tabKeys.add(key); i...
3.26
framework_VTabsheetBase_clearTabKeys_rdh
/** * For internal use only. May be removed or replaced in the future. */ public void clearTabKeys() { tabKeys.clear(); disabledTabKeys.clear(); }
3.26
framework_VTabsheetBase_setActiveTabIndex_rdh
/** * For internal use only. May be removed or replaced in the future. * * @param activeTabIndex * the index of the currently active tab */ public void setActiveTabIndex(int activeTabIndex) { this.activeTabIndex = activeTabIndex; }
3.26
framework_VTabsheetBase_setReadonly_rdh
/** * For internal use only. May be removed or replaced in the future. * * @param readonly * {@code true} if this widget should be read-only, {@code false} * otherwise */ public void setReadonly(boolean readonly) { this.readonly = readonly; }
3.26
framework_VTabsheetBase_setConnector_rdh
/** * Sets the connector that should be notified of events etc. * * For internal use only. This method may be removed or replaced in the * future. * * @since 7.2 * @param connector * the connector of this widget */ public void setConnector(AbstractComponentConnector connector) { this.connector = connecto...
3.26
framework_VTabsheetBase_getConnectorForWidget_rdh
/** * For internal use only. May be removed or replaced in the future. * * @param widget * the widget whose connector to find * @return the connector */ protected ComponentConnector getConnectorForWidget(Widget widget) { return ConnectorMap.get(client).getConnector(widget); }
3.26
framework_VTabsheetBase_setEnabled_rdh
/** * For internal use only. May be removed or replaced in the future. */ @Override public void setEnabled(boolean enabled) { disabled = !enabled; }
3.26
framework_VTabsheetBase_setTabCaptionsAsHtml_rdh
/** * Sets whether the caption is rendered as HTML. * <p> * The default is false, i.e. render tab captions as plain text * <p> * This value is delegated from the TabsheetState. * * @since 7.4 * @param tabCaptionsAsHtml * {@code true} if the captions are rendered as HTML, * {@code false} if rendered as pla...
3.26
framework_VTabsheetBase_setClient_rdh
/** * For internal use only. May be removed or replaced in the future. * * @param client * the current application connection instance */ public void setClient(ApplicationConnection client) { this.client = client; }
3.26
framework_SortEvent_m0_rdh
/** * Returns whether this event originated from actions done by the user. * * @return true if sort event originated from user interaction */ public boolean m0() { return userOriginated; }
3.26
framework_SortEvent_getOrder_rdh
/** * Get the sort ordering that is to be applied to the Grid. * * @return a list of sort order objects */ public List<SortOrder> getOrder() {return order; }
3.26
framework_SortEvent_getSource_rdh
/** * Get access to the Grid that fired this event. * * @return the grid instance */ @Override public Grid<T> getSource() { return grid; }
3.26
framework_LegacyLocatorStrategy_getElementsByPath_rdh
/** * {@inheritDoc } */ @Override public List<Element> getElementsByPath(String path) { // This type of search is not supported in LegacyLocator List<Element> v17 = new ArrayList<>(); ...
3.26
framework_LegacyLocatorStrategy_getElementByPath_rdh
/** * {@inheritDoc } */ @Override public Element getElementByPath(String path) { return getElementByPathStartingAt(path, null); }
3.26
framework_LegacyLocatorStrategy_getElementsByPathStartingAt_rdh
/** * {@inheritDoc } */ @Override public List<Element> getElementsByPathStartingAt(String path, Element root) { // This type of search is not supported in LegacyLocator List<Element> array = new ArrayList<>(); Element e = getElementByPathStartingAt(path, root); if (e != null) { array.add(e);}...
3.26
framework_LegacyLocatorStrategy_getElementByPathStartingAt_rdh
/** * {@inheritDoc } */ @Override public Element getElementByPathStartingAt(String path, Element baseElement) { /* Path is of type "targetWidgetPath#componentPart" or "targetWidgetPath". */ String[] parts = path.split(LegacyLocatorStrategy.SUBPART_SEPARATOR, 2); String widgetPath = parts[0]; ...
3.26
framework_LegacyLocatorStrategy_getPathForWidget_rdh
/** * Creates a locator String for the given widget. The path can be used to * locate the widget using {@link #getWidgetFromPath(String, Widget)}. * <p/> * Returns null if no path can be determined for the widget or if the widget * is null. * * @param w * The target widget * @return A String locator for the ...
3.26
framework_VAccordion_setHeightFromWidget_rdh
/** * Queries the height from the wrapped widget and uses it to set this * stack item's height. */ public void setHeightFromWidget() { Widget widget = getChildWidget(); if (widget == null) { return; } int paintableHeight = widget.getElement().getOffsetHeight(); setHeight(paintableHeight...
3.26
framework_VAccordion_replaceWidget_rdh
/** * Replaces the existing wrapped widget (if any) with a new widget. * * @param newWidget * the new widget to wrap */ public void replaceWidget(Widget newWidget) { if (widget != null) { widgets.remove(widget); if (open) { remove(widget); } } widget = newWidget; ...
3.26
framework_VAccordion_open_rdh
/** * Opens the stack item and clears any previous visibility settings. */ public void open() { add(widget, content); open = true; content.getStyle().setTop(getCaptionHeight(), Unit.PX); content.getStyle().setLeft(0, Unit.PX); content.getStyle().clearVisibility(); addStyleDependentName("...
3.26
framework_VAccordion_isCaptionVisible_rdh
/** * Returns whether the caption element is visible or not. * * @return {@code true} if visible, {@code false} otherwise * @deprecated This method is not called by the framework code anymore. */ @Deprecated public boolean isCaptionVisible() { return caption.isVisible(); }
3.26
framework_VAccordion_updateTabStyleName_rdh
/** * Updates the stack item's style name from the TabState. * * @param newStyleName * the new style name */ private void updateTabStyleName(String newStyleName) { if ((newStyleName != null) && (!newStyleName.isEmpty())) { if (!newStyleName.equals(styleName)) { // If we have a new style...
3.26
framework_VAccordion_clearPaintables_rdh
/** * {@inheritDoc } * * @deprecated This method is not called by the framework code anymore. */ @Deprecated@Override protected void clearPaintables() { clear(); }
3.26
framework_VAccordion_getWidgetWidth_rdh
/** * Returns the offset width of the wrapped widget. * * @return the offset width in pixels, or zero if no widget is set */ public int getWidgetWidth() { if (widget == null) { return 0; } return widget.getOffsetWidth(); } /** * Returns whether the given container's widget is this stack item's...
3.26
framework_VAccordion_updateStyleNames_rdh
/** * Updates the primary style name base for all stack items. * * @param primaryStyleName * the new primary style name base */ protected void updateStyleNames(String primaryStyleName) { for (Widget w : getChildren()) { if (w instanceof StackItem) { StackItem item = ((StackItem) (w)); ...
3.26
framework_VAccordion_getCaptionHeight_rdh
/** * Returns the offset height of the caption node. * * @return the height in pixels */ public int getCaptionHeight() { return captionNode.getOffsetHeight(); }
3.26
framework_VAccordion_getStackItem_rdh
/** * For internal use only. May be removed or replaced in the future. * * @param index * the index of the stack item to get * @return the stack item */ public StackItem getStackItem(i...
3.26
framework_VAccordion_setWidth_rdh
/** * Sets the width of the stack item, or removes it if given value is * {@code -1}. * * @param width * the width to set (in pixels), or {@code -1} to remove * width */ public void setWidth(int width) { if (width == (-1)) {super.setWidth(""); } else { super.setWidth(width + "px"); } } /** * ...
3.26
framework_VAccordion_setTabIndex_rdh
/** * For internal use only. May be renamed or removed in a future release. * <p> * Sets the tabulator index for the active stack item. The active stack item * represents the entire accordion in the browser's focus cycle (excluding * any focusable elements within the content panel). * <p> * This value is delegat...
3.26
framework_VAccordion_setHeight_rdh
/** * Sets the height for this stack item's contents. * * @param height * the height to set (in pixels), or {@code -1} to remove * height */public void setHeight(int height) { if (height == (-1)) { super.setHeight(""); content.getStyle().setHeight(0, Unit.PX);} else { super.set...
3.26
framework_VAccordion_setId_rdh
/** * Sets the identifier for this stack item. * * @param newId * the identifier to set */ public void setId(String newId) { if (!SharedUtil.equals(newId, id)) { if (id != null) { getElement().removeAttribute("id"); } id = newId; if ((id != null) && (!id.isEmpty(...
3.26
framework_VAccordion_getStackItems_rdh
/** * Returns an iterable over all the stack items. * * @return the iterable */ @SuppressWarnings({ "rawtypes", "unchecked" }) public Iterable<StackItem> getStackItems() { return ((Iterable) (getChildren())); }
3.26
framework_VAccordion_setContent_rdh
/** * Updates the content of the open tab of the accordion. * * This method is mostly for internal use and may change in future * versions. * * @since 7.2 * @param newWidget * new content */ public void setContent(Widget newWidget) { if (widget == null) { widget = newWidget; widgets.add...
3.26
framework_VAccordion_getContainerElement_rdh
/** * Returns the container element for the content widget. * * @return the content container element */ @SuppressWarnings("deprecation")public Element getContainerElement() { return DOM.asOld(content); }
3.26
framework_VAccordion_updateCaption_rdh
/** * Updates the caption to match the current tab state. * * @param tabState * the state for this stack item */ @SuppressWarnings("deprecation") public void updateCaption(TabState tabState) { // Need to call this because the caption does not have an owner, and // cannot have an owner, because only the s...
3.26
framework_VAccordion_close_rdh
/** * Closes this stack item and removes the wrapped widget from the DOM * tree and this stack item. */ public void close() { if (widget != null) { remove(widget); } content.getStyle().setVisibility(Visibility.HIDDEN); content.getStyle().setTop(-100000, Unit.PX); content.getStyle().setL...
3.26
framework_VAccordion_hide_rdh
/** * Hides the stack item content but does not close the stack item. * * @deprecated This method is not called by the framework code anymore. */@Deprecatedpublic void hide() { content.getStyle().setVisibility(Visibility.HIDDEN); }
3.26
framework_FieldBinder_getFields_rdh
/** * Returns a list containing Field objects reflecting all the fields of the * class or interface represented by this Class object. The fields in * superclasses are excluded. * * @param searchClass * the class to be scanned for fields * @return the list of fields in this class */ protected static List<Field...
3.26
framework_FieldBinder_bindField_rdh
/** * Tries to bind the given {@link Component} instance to a member field of * the bind target. The fields are matched based on localId, id and caption. * * @param instance * the instance to be bound to a field * @param localId * the localId used for mapping the field to an instance field * @return true on...
3.26
framework_FieldBinder_asFieldName_rdh
/** * Converts the given identifier to a valid field name by stripping away * illegal character and setting the first letter of the name to lower case. * * @param identifier * the identifier to be converted to field name * @return the field name corresponding the identifier */private static String asFieldName(...
3.26
framework_FieldBinder_resolveFields_rdh
/** * Resolves the fields of the design class instance. */ private void resolveFields(Class<?> classWithFields) { for (Field memberField : getFields(classWithFields)) { if (Component.class.isAssignableFrom(memberField.getType())) { fieldMap.put(memberField.getName().toLowerCase(Locale.ROOT), memberField);...
3.26
framework_FieldBinder_getUnboundFields_rdh
/** * Returns a collection of field names that are not bound. * * @return a collection of fields assignable to Component that are not bound */ public Collection<String> getUnboundFields() throws FieldBindingException { List<String> unboundFields = new ArrayList<>(); for (Field f : fieldMap.values()) ...
3.26
framework_DefaultEditorEventHandler_getDeltaFromKeyDownEvent_rdh
/** * Returns the direction to which the cursor should move. * * @param event * the mouse event, not null. * @return the direction. May return null if the cursor should not move. */ protected CursorMoveDelta getDeltaFromKeyDownEvent(EditorDomEvent<T> event) { Event e = event.getDomEvent(); ...
3.26
framework_DefaultEditorEventHandler_isTouchOpenEvent_rdh
/** * Returns whether the given event is a touch event that should open the * editor. * * @param event * the received event * @return whether the event is a touch open event */ protected boolean isTouchOpenEvent(EditorDomEvent<T> event) { final Event e = event.getDomEvent(); final int type = e.getType...
3.26
framework_DefaultEditorEventHandler_isEditable_rdh
/** * Checks whether the field within the given editor column is editable. * * @param grid * the grid that is being edited * @param column * the column to investigate * @return {@code true} if the field is editable, {@code false} otherwise */ protected boolean isEditable(Grid<T> grid, Grid.Column<?, T> colu...
3.26
framework_DefaultEditorEventHandler_editRow_rdh
/** * Opens the editor over the row with the given index and attempts to focus * the editor widget in the given column index. If the given indices are * outside of the existing range, the closest value within the range is * used. * * @param event * the wrapped DOM event * @param rowIndex * index of the row...
3.26
framework_DefaultEditorEventHandler_m1_rdh
/** * Returns whether the cursor move has either horizontal or vertical * changes. * * @return {@code true} if there are changes, {@code false} otherwise */ public boolean m1() {return (rowDelta != 0) || (colDelta != 0); }
3.26
framework_DefaultEditorEventHandler_m0_rdh
/** * Returns whether the given event should open the editor. The default * implementation returns true if and only if the event is a doubleclick or * if it is a keydown event and the keycode is {@link #KEYCODE_OPEN}. * * @param event * the received event * @return true if the event is an open event, false oth...
3.26
framework_DefaultEditorEventHandler_triggerValueChangeEvent_rdh
/** * Triggers a value change event from the editor field if it has focus. This * is based on the assumption that editor field will fire the value change * when a blur event occurs. * * @param event * the editor DOM event */ private void triggerValueChangeEvent(EditorDomEvent<T> event) { // Force a blur to...
3.26
framework_LocatorUtil_indexOfIgnoringQuoted_rdh
/** * Find first occurrence of character that's not inside quotes starting from * specified index. * * @param str * Full string for searching * @param find * Character we want to find * @param startingAt * Index where we start * @return Index of character. -1 ...
3.26
framework_LocatorUtil_isUIElement_rdh
/** * Checks if path refers to vaadin UI element com.vaadin.ui.UI. * * @param path * to vaadin element * @return true if path refers to UI element, false otherwise */ public static boolean isUIElement(String path) { String regex = "^\\/{0,2}(com\\.vaadin\\.ui\\.)?V?UI[\\/\\[]?"; RegExp regexp = RegExp.c...
3.26
framework_LocatorUtil_isNotificationElement_rdh
/** * Checks if path refers to vaadin Notification element * com.vaadin.ui.Notification. * * @param path * to vaadin element * @return true if path refers to Notification element, false otherwise */ public static boolean isNotificationElement(String path) { String regex = "^\\/{0,2}(com\\.vaadin\\.ui\\....
3.26
framework_Profiler_reset_rdh
/** * Resets the collected profiler data. Calls to this method will be removed * by the compiler unless profiling is enabled. */ public static void reset() { if (isEnabled()) {/* Old implementations might call reset for initialization, so ensure it is initialized here as well. Initialization has no side effe...
3.26
framework_Profiler_getOwnTime_rdh
/** * Gets the total time spent in this node, excluding time spent in sub * nodes. * * @return the total time spent, in milliseconds */ public double getOwnTime() { double time = getTimeSpent(); for (Node node : children.values()) { time -= node.getTimeSpent(); } return time; }
3.26
framework_Profiler_setProfilerResultConsumer_rdh
/** * Sets the profiler result consumer that is used to output the profiler * data to the user. * <p> * <b>Warning!</b> This is internal API and should not be used by * applications or add-ons. * * @since 7.1.4 * @param profilerResultConsumer * the consumer that gets profiler data */ public static void setP...
3.26
framework_Profiler_leave_rdh
/** * Leaves a named block. There should always be a matching invocation of * {@link #enter(String)} when entering the block. Calls to this method will * be removed by the compiler unless profiling is enabled. * * @param name * the name of the left block */ public static void leave(String name) { if (isEnable...
3.26
framework_Profiler_initialize_rdh
/** * Initializes the profiler. This should be done before calling any other * function in this class. Failing to do so might cause undesired behavior. * This method has no side effects if the initialization has already been * done. * <p> * Please note that this method should be called even if the profiler is not...
3.26
framework_Profiler_m1_rdh
/** * Outputs the gathered profiling data to the debug console. */ public static void m1() {if (!isEnabled()) { getLogger().warning("Profiler is not enabled, no data has been collected."); return; } LinkedList<Node> stack = new LinkedList<>(); Node rootNode = new Node(null); stack.add(rootNode);JsArray<GwtStatsEvent>...
3.26
framework_Profiler_getRelativeTimeMillis_rdh
/** * Returns time relative to the particular page load time. The value should * not be used directly but rather difference between two values returned by * this method should be used to compare measurements. * * @since 7.6 */ public static double getRelativeTimeMillis() { return RELATIVE_TIME_SUPPLIER.getRelativ...
3.26
framework_Profiler_getMaxTimeSpent_rdh
/** * Gets the maximum time spent for one invocation of this node, * including time spent in sub nodes. * * @return the time spent for the slowest invocation, in milliseconds */ public double getMaxTimeSpent() { return maxTime; }
3.26
framework_Profiler_logBootstrapTimings_rdh
/** * Outputs the time passed since various events recored in * performance.timing if supported by the browser. */ public static void logBootstrapTimings() { if (isEnabled()) { double now = Duration.currentTimeMillis(); String[] keys = new String[]{ "navigationStart", "unloadEventStart", "unloadEventEnd", "redirectS...
3.26
framework_Profiler_enter_rdh
/** * Enters a named block. There should always be a matching invocation of * {@link #leave(String)} when leaving the block. Calls to this method will * be removed by the compiler unless profiling is enabled. * * @param name * the name of the entered block */ public static void enter(String name) { if (isEnabl...
3.26
framework_Profiler_enterChild_rdh
/** * Creates a new child node or retrieves and existing child and updates * its total time and hit count. * * @param name * the name of the child * @param timestamp * the timestamp for when the node is entered * @return the child node object */ public Node enterChild(String name, double timestamp) { ...
3.26
framework_FileDropTargetConnector_uploadNextFile_rdh
/** * Uploads a file from the waiting list in case there are no files being * uploaded. */ private void uploadNextFile() { Scheduler.get().scheduleDeferred(() -> { if ((!uploading) && (!uploadUrls.isEmpty())) { uploading = true; String nextId = uploadUrls.keySet().stream().findAn...
3.26
framework_AbstractTransactionalQuery_releaseConnection_rdh
/** * Releases the connection if it is not part of an active transaction. * * @param conn * the connection to release */ private void releaseConnection(Connection conn) { if ((conn != activeConnection) && (conn != null)) { connectionPool.releaseConnection(conn); } }
3.26
framework_AbstractTransactionalQuery_rollback_rdh
/** * Rolls back and releases the active connection. * * @throws SQLException * if not in a transaction managed by this query */ public void rollback() throws UnsupportedOperationException, SQLException { if (!isInTransaction()) { throw new SQLException("No active transaction"); } activeCon...
3.26
framework_AbstractTransactionalQuery_beginTransaction_rdh
/** * Reserves a connection with auto-commit off if no transaction is in * progress. * * @throws IllegalStateException * if a transaction is already open * @throws SQLException * if a connection could not be obtained or configured */ public void beginTransaction() throws UnsupportedOperationException, SQLEx...
3.26
framework_AbstractTransactionalQuery_commit_rdh
/** * Commits (if not in auto-commit mode) and releases the active connection. * * @throws SQLException * if not in a transaction managed by this query */ public void commit() throws UnsupportedOperationException, SQLException { if (!isInTransaction()) { throw new SQLException("No active transactio...
3.26
framework_VaadinFinderLocatorStrategy_generateQueries_rdh
/** * Function to generate all possible search paths for given component list. * Function strips out all the com.vaadin.ui. prefixes from elements as this * functionality makes generating a query later on easier. * * @param components * List of components * @return List of Vaadin selectors */ private List<Str...
3.26
framework_VaadinFinderLocatorStrategy_filterMatches_rdh
/** * Go through a list of potentially matching components, modifying that list * until all elements that remain in that list match the complete list of * predicates. * * @param potentialMatches * a list of component connectors. Will be changed. * @param predicates * an immutable list of predicates * @retu...
3.26
framework_VaadinFinderLocatorStrategy_getElementsByPathStartingAt_rdh
/** * {@inheritDoc } */ @Override public List<Element> getElementsByPathStartingAt(String path, Element root) { List<SelectorPredicate> postFilters = SelectorPredicate.extractPostFilterPredicates(path); if (!postFilters.isEmpty()) { path = path.substring(1, path.lastIndexOf(')')); } final Com...
3.26
framework_VaadinFinderLocatorStrategy_getElementByPath_rdh
/** * {@inheritDoc } */ @Override public Element getElementByPath(String path) { List<Element> elements = getElementsByPath(path); if (elements.isEmpty()) { return null; } return elements.get(0); }
3.26
framework_VaadinFinderLocatorStrategy_getBestSelector_rdh
/** * Search different queries for the best one. Use the fact that the lowest * possible index is with the last selector. Last selector is the full * search path containing the complete Component hierarchy. * * @param selectors * List of selectors * @param target * Target element * @param subPart * sub ...
3.26
framework_VaadinFinderLocatorStrategy_getElementByPathStartingAt_rdh
/** * {@inheritDoc } */ @Override public Element getElementByPathStartingAt(String path, Element root) { List<Element> elements = getElementsByPathStartingAt(path, root); if (elements.isEmpty()) { return null; } return elements.get(0); }
3.26
framework_VaadinFinderLocatorStrategy_getElementsByPath_rdh
/** * {@inheritDoc } */ @Override public List<Element> getElementsByPath(String path) { List<SelectorPredicate> postFilters = SelectorPredicate.extractPostFilterPredicates(path); if (!postFilters.isEmpty()) { path = path.substring(1, path.lastIndexOf(')')); } List<Element> elements = new Arr...
3.26
framework_VaadinFinderLocatorStrategy_getPathForElement_rdh
/** * {@inheritDoc } */ @Override public String getPathForElement(Element targetElement) { Element oldTarget = targetElement;Widget targetWidget = Util.findPaintable(client, targetElement).getWidget(); targetElement = targetWidget.getElement(); // Find SubPart name if needed. String subPart = null...
3.26
framework_VaadinFinderLocatorStrategy_getTags_rdh
/** * Gets the tags for server side class name. Also includes tags for older * components in v7 package. * * @param widgetName * the server side class name for widget * @return list of tags */ private List<Integer> getTags(String widgetName) { List<Integer> widgetTags = new ArrayList<>(); Arrays....
3.26
framework_VaadinFinderLocatorStrategy_findNotificationsByPath_rdh
/** * Special case for finding notifications as they have no connectors and are * directly attached to {@link RootPanel}. * * @param path * The path of the notification, should be * {@code "//VNotification"} optionally followed by an index in * brackets. * @return the notification element or null if not f...
3.26
framework_VaadinFinderLocatorStrategy_getWidgetName_rdh
/** * Extracts the name of the widget class from a path fragment * * @param pathFragment * the path fragment * @return the name of the widget class. */ private String getWidgetName(String pathFragment) { String widgetName = pathFragment; int ixBracket = pathFragment.indexOf('['); if (ixBracket >= 0)...
3.26
framework_AbstractInlineDateFieldConnector_updateListeners_rdh
/** * Updates listeners registered (or register them) for the widget based on * the current resolution. * <p> * Subclasses may override this method to keep the common logic inside the * {@link #updateFromUIDL(UIDL, ApplicationConnection)} method as is and * customizing only listeners logic. */ @SuppressWarnings(...
3.26
framework_UIProviderEvent_getService_rdh
/** * Gets the Vaadin service from which the event originates. * * @return the Vaadin service */ public VaadinService getService() { return ((VaadinService) (getSource())); }
3.26
framework_Navigator_m1_rdh
/** * Sets the URI fragment to the given string. * * @param fragment * The new URI fragment. */ protected void m1(String fragment) { page.setUriFragment(fragment, false); }
3.26
framework_Navigator_beforeViewChange_rdh
/** * Check whether view change is allowed by view change listeners ( * {@link ViewChangeListener#beforeViewChange(ViewChangeEvent)}). * * This method can be overridden to extend the behavior, and should not be * called directly except by {@link #navigateTo(View, String, String)}. * * @since 7.6 * @param event ...
3.26
framework_Navigator_parseParameterStringToMap_rdh
/** * Parses the given parameter string to a map using the given separator * string. * * @param parameterString * the parameter string to parse * @param separator * the string (typically one character) used to separate values * from each other * @return The navigation state as Map<String, String>. * @si...
3.26
framework_Navigator_switchView_rdh
/** * Update the internal state of the navigator to reflect the actual * switching of views. * * This method should only be called by * {@link #navigateTo(View, String, String)} between showing the view and * calling {@link View#enter(ViewChangeEvent)}. If this method is * overridden, the overriding version must...
3.26
framework_Navigator_getDisplay_rdh
/** * Return the {@link ViewDisplay} used by the navigator. * * @return the ViewDisplay used for displaying views */ public ViewDisplay getDisplay() { return f0; }
3.26
framework_Navigator_getCurrentNavigationState_rdh
/** * Returns the current navigation state for which the * {@link #getCurrentView()} has been constructed. This may differ to * {@link #getState()} in case the URL has been changed on the browser and * the navigator wasn't yet given an opportunity to construct new view. The * state is in the form of * <code>curre...
3.26
framework_Navigator_createNavigationStateManager_rdh
/** * Creates a navigation state manager for given UI. This method should take * into account any navigation related annotations. * * @param ui * the ui * @return the navigation state manager * @since 8.2 */ protected NavigationSt...
3.26
framework_Navigator_addViewChangeListener_rdh
/** * Listen to changes of the active view. * <p> * Registered listeners are invoked in registration order before ( * {@link ViewChangeListener#beforeViewChange(ViewChangeEvent) * beforeViewChange()}) and after ( * {@link ViewChangeListener#afterViewChange(ViewChangeEvent) * afterViewChange()}) a view change occ...
3.26
framework_Navigator_setErrorView_rdh
/** * Registers a view class that is instantiated when no other view matches * the navigation state. This implicitly sets an appropriate error view * provider and overrides any previous * {@link #setErrorProvider(ViewProvider)} call. * <p> * Note that an error view should not be shared...
3.26
framework_Navigator_fireAfterViewChange_rdh
/** * Fires an event after the current view has changed. * <p> * Listeners are called in registration order. * * @param event * view change event (not null) */ protected void fireAfterViewChange(ViewChangeEvent event) { // a copy of the listener list is needed to avoid // ConcurrentModificationExceptio...
3.26
framework_Navigator_removeProvider_rdh
/** * Unregister a view provider (factory). * * @param provider * provider to unregister */ public void removeProvider(ViewProvider provider) { providers.remove(provider); }
3.26
framework_Navigator_updateNavigationState_rdh
/** * Update the internal state of the navigator (parameters, previous * successful URL fragment navigated to) when navigation succeeds. * * Normally this method should not be overridden nor called directly from * application code, but it can be called by a custom implementation of * {@link #navigateTo(View, Stri...
3.26
framework_Navigator_getViewProvider_rdh
/** * Get view provider that handles the given {@code state}. * * @param state * state string * @return suitable provider */ protected ViewProvider getViewProvider(String state) { String longestViewName = null; ViewProvider longestViewNameProvider = null; for (ViewProvider provider : providers) { ...
3.26
framework_Navigator_removeView_rdh
/** * Removes a view from navigator. * <p> * This method only applies to views registered using * {@link #addView(String, View)} or {@link #addView(String, Class)}. * * @param viewName * name of the view to remove */ public void removeView(String viewName) { Iterator<ViewProvider> it = providers.itera...
3.26
framework_Navigator_destroy_rdh
/** * Creates view change event for given {@code view}, {@code viewName} and * {@code parameters}. * * @since 7.6.7 */ public void destroy() { stateManager.setNavigator(null); ui.setNavigator(null); }
3.26
framework_Navigator_revertNavigation_rdh
/** * Revert the changes to the navigation state. When navigation fails, this * method can be called by {@link #navigateTo(View, String, String)} to * revert the URL fragment to point to the previous view to which navigation * succeeded. * * This method should only be called by * {@link #navigateTo(View, String,...
3.26
framework_Navigator_m2_rdh
/** * Get the view class for this provider. * * @return {@link View} class */ public Class<? extends View> m2() { return viewClass; }
3.26
framework_Navigator_getState_rdh
/** * Returns the current navigation state reported by this Navigator's * {@link NavigationStateManager}. * <p> * When the navigation is triggered by the browser (for example by pressing * the back or forward button in the browser), the navigation state may * already have been updated to reflect the new address, ...
3.26
framework_Navigator_addProvider_rdh
/** * Registers a view provider (factory). * <p> * Providers are called in order of registration until one that can handle * the requested view name is found. * * @param provider * provider to register, not <code>null</code> * @throws IllegalArgumentException * if the provided view provider is <code>null</...
3.26