Class RouterLink

Constructor Detail

• RouterLink

  public RouterLink()

  Creates a new empty router link.

• RouterLink

  public RouterLink(String text,
                    Class<? extends Component> navigationTarget)

  Creates a new router link for the given navigation target using the given text.

  Parameters:

  text - link text

  navigationTarget - navigation target

• RouterLink

  public RouterLink(String text,
                    Class<? extends C> navigationTarget,
                    T parameter)

  Creates a new router link for the given navigation target using the given text and parameter.

  Type Parameters:

  T - url parameter type

  C - navigation target type

  Parameters:

  text - link text

  navigationTarget - navigation target

  parameter - url parameter for navigation target

• RouterLink

  public RouterLink(Router router,
                    String text,
                    Class<? extends Component> navigationTarget)

  Creates a new router link for the given navigation target using the given text.

  Parameters:

  router - router used for navigation

  text - link text

  navigationTarget - navigation target

• RouterLink

  public RouterLink(Router router,
                    String text,
                    Class<? extends C> navigationTarget,
                    T parameter)

  Creates a new router link for the given navigation target using the given text and parameter.

  Type Parameters:

  T - url parameter type

  C - navigation target type

  Parameters:

  router - router used for navigation

  text - link text

  navigationTarget - navigation target

  parameter - url parameter for navigation target

Method Detail

• setRoute

  public void setRoute(Router router,
                       Class<? extends Component> navigationTarget)

  Set the navigation target for this link.

  Parameters:

  router - router used for navigation

  navigationTarget - navigation target

• setRoute

  public <T,C extends Component & HasUrlParameter<T>> void setRoute(Router router,
                                                                    Class<? extends C> navigationTarget,
                                                                    T parameter)

  Set the navigation target for this link.

  Type Parameters:

  T - url parameter type

  C - navigation target type

  Parameters:

  router - router used for navigation

  navigationTarget - navigation target

  parameter - url parameter for navigation target

• getHref

  public String getHref()

  Gets the href (the URL) of this link.

  Returns:

  the href

• getQueryParameters

  public Optional<QueryParameters> getQueryParameters()

  Gets the QueryParameters of this link.

  Returns:

  an optional of QueryParameters, or an empty optional if there are no query parameters set

  See Also:

  setQueryParameters(QueryParameters)

• setQueryParameters

  public void setQueryParameters(QueryParameters queryParameters)

  Sets the QueryParameters of this link.

  The query string will be generated from QueryParameters.getQueryString() and will be appended to the href attribute of this link.

  Parameters:

  queryParameters - the query parameters object, or null to remove existing query parameters

• getHighlightCondition

  public HighlightCondition<RouterLink> getHighlightCondition()

  Gets the HighlightCondition of this link.

  The default condition is to checked whether the current location starts with this link's getHref() value, as defined in HighlightConditions.locationPrefix().

  Returns:

  the highlight condition, never null

  See Also:

  setHighlightCondition(HighlightCondition)

• setHighlightCondition

  public void setHighlightCondition(HighlightCondition<RouterLink> highlightCondition)

  Sets the HighlightCondition of this link, which determines if the link should be highlighted when a AfterNavigationEvent occurs.

  The evaluation of this condition will be processed by this link's HighlightAction.

  Parameters:

  highlightCondition - the highlight condition, not null

  See Also:

  setHighlightAction(HighlightAction), HighlightConditions

• getHighlightAction

  public HighlightAction<RouterLink> getHighlightAction()

  Gets the HighlightAction of this link.

  The default action is to toggle the highlight attribute of the element, as defined in HighlightActions.toggleAttribute(String).

  Returns:

  the highlight action, never null

  See Also:

  setHighlightAction(HighlightAction)

• setHighlightAction

  public void setHighlightAction(HighlightAction<RouterLink> highlightAction)

  Sets the HighlightAction of this link, which will be performed with the evaluation of this link's HighlightCondition.

  The old action will be executed passing false to HighlightAction.highlight(Object, boolean) to clear any previous highlight state.

  Parameters:

  highlightAction - the highlight action, not null

  See Also:

  setHighlightCondition(HighlightCondition), HighlightActions

• afterNavigation

  public void afterNavigation(AfterNavigationEvent event)

  Description copied from interface: AfterNavigationHandler

  Method called after navigation has been executed.

  Specified by:

  afterNavigation in interface AfterNavigationHandler

  Parameters:

  event - after navigation event with event details