BootstrapPageResponse
instance passed via
BootstrapListener
instead, or acquire the UI
via
BootstrapListener
for certain modifications and
configuration. For more details, see PageConfigurator
deprecation message. To be removed after the next long term
support release (targeted Vaadin 23).@Deprecated public class InitialPageSettings extends Object implements Serializable
Modifier and Type | Class and Description |
---|---|
static class |
InitialPageSettings.Position
Deprecated.
Append position enum.
|
static class |
InitialPageSettings.WrapMode
Deprecated.
Content wrapping mode enum.
|
Constructor and Description |
---|
InitialPageSettings(VaadinRequest request,
UI ui,
AfterNavigationEvent afterNavigationEvent,
WebBrowser browser)
Deprecated.
Create new initial page settings object.
|
Modifier and Type | Method and Description |
---|---|
void |
addFavIcon(InitialPageSettings.Position position,
String rel,
String href,
String sizes)
Deprecated.
Append a fav icon link to initial page head.
|
void |
addFavIcon(String rel,
String href,
String sizes)
Deprecated.
Append a fav icon link to initial page head.
|
void |
addInlineFromFile(InitialPageSettings.Position position,
String file,
InitialPageSettings.WrapMode type)
Deprecated.
Inline contents from classpath file to head of initial page.
|
void |
addInlineFromFile(String file,
InitialPageSettings.WrapMode type)
Deprecated.
Inline contents from classpath file to append to head of initial page.
|
void |
addInlineWithContents(InitialPageSettings.Position position,
String contents,
InitialPageSettings.WrapMode type)
Deprecated.
Add content to head of initial page.
|
void |
addInlineWithContents(String contents,
InitialPageSettings.WrapMode type)
Deprecated.
Add content to append to head of initial page.
|
void |
addLink(InitialPageSettings.Position position,
String href)
Deprecated.
Add a link to initial page head.
|
void |
addLink(InitialPageSettings.Position position,
String href,
Map<String,String> attributes)
Deprecated.
Add a link to initial page head.
|
void |
addLink(InitialPageSettings.Position position,
String rel,
String href)
Deprecated.
Add a link to initial page head.
|
void |
addLink(String href)
Deprecated.
Add a link to be appended to initial page head.
|
void |
addLink(String href,
Map<String,String> attributes)
Deprecated.
Append a link to initial page head.
|
void |
addLink(String rel,
String href)
Deprecated.
Append a link to initial page head.
|
void |
addMetaTag(InitialPageSettings.Position position,
String name,
String content)
Deprecated.
Add a meta tag to initial page head.
|
void |
addMetaTag(String name,
String content)
Deprecated.
Add a meta tag to be appended to initial page head.
|
AfterNavigationEvent |
getAfterNavigationEvent()
Deprecated.
Get the after navigation event.
|
WebBrowser |
getBrowser()
Deprecated.
Get the web browser used for the request used for these settings.
|
protected List<org.jsoup.nodes.Element> |
getElement(InitialPageSettings.Position position)
Deprecated.
Get the list of links to append to head.
|
protected List<elemental.json.JsonObject> |
getInline(InitialPageSettings.Position position)
Deprecated.
Get the list of inline objects to append to head.
|
LoadingIndicatorConfiguration |
getLoadingIndicatorConfiguration()
Deprecated.
Returns the configuration object for loading indicator.
|
PushConfiguration |
getPushConfiguration()
Deprecated.
Returns the object used for configuring the push channel.
|
ReconnectDialogConfiguration |
getReconnectDialogConfiguration()
Deprecated.
Returns the configuration object for reconnect dialog.
|
VaadinRequest |
getRequest()
Deprecated.
Get the initial request for the settings.
|
UI |
getUi()
Deprecated.
Get the target UI instance.
|
protected String |
getViewport()
Deprecated.
Get the currently set viewport setting for this settings object.
|
void |
setViewport(String viewport)
Deprecated.
Set the viewport value.
|
public InitialPageSettings(VaadinRequest request, UI ui, AfterNavigationEvent afterNavigationEvent, WebBrowser browser)
request
- initial requestui
- target uiafterNavigationEvent
- after navigation eventbrowser
- browser informationpublic VaadinRequest getRequest()
public UI getUi()
public AfterNavigationEvent getAfterNavigationEvent()
public WebBrowser getBrowser()
public void setViewport(String viewport)
viewport
- viewport value to setprotected String getViewport()
Note! this will not reflect any setting made using
Viewport
public void addInlineFromFile(String file, InitialPageSettings.WrapMode type)
file
- dependency file to read and write to headtype
- dependency typepublic void addInlineFromFile(InitialPageSettings.Position position, String file, InitialPageSettings.WrapMode type)
position
- prepend or appendfile
- dependency file to read and write to headtype
- dependency typepublic void addInlineWithContents(String contents, InitialPageSettings.WrapMode type)
contents
- inline content to be added to the pagetype
- type of content which can be JavaScript or Stylesheet (CSS)public void addInlineWithContents(InitialPageSettings.Position position, String contents, InitialPageSettings.WrapMode type)
position
- prepend or appendcontents
- inline content to be added to the pagetype
- type of content which can be JavaScript or Stylesheet (CSS)protected List<elemental.json.JsonObject> getInline(InitialPageSettings.Position position)
position
- prepend or appendprotected List<org.jsoup.nodes.Element> getElement(InitialPageSettings.Position position)
position
- prepend or appendpublic void addLink(String href)
href
- link hrefpublic void addLink(InitialPageSettings.Position position, String href)
position
- prepend or appendhref
- link hrefpublic void addLink(String href, Map<String,String> attributes)
href
- location of the linked documentattributes
- map of attributes for link elementpublic void addLink(InitialPageSettings.Position position, String href, Map<String,String> attributes)
position
- prepend or appendhref
- location of the linked documentattributes
- map of attributes for link elementpublic void addLink(String rel, String href)
rel
- link relationshiphref
- location of the linked documentpublic void addLink(InitialPageSettings.Position position, String rel, String href)
position
- prepend or appendrel
- link relationshiphref
- location of the linked documentpublic void addFavIcon(String rel, String href, String sizes)
rel
- link relationshiphref
- location of the fav iconsizes
- size of the linked fav iconpublic void addFavIcon(InitialPageSettings.Position position, String rel, String href, String sizes)
position
- prepend or appendrel
- link relationshiphref
- location of the fav iconsizes
- size of the linked fav iconpublic void addMetaTag(String name, String content)
name
- meta tag namecontent
- meta tag contentpublic void addMetaTag(InitialPageSettings.Position position, String name, String content)
position
- prepend or appendname
- meta tag namecontent
- meta tag contentpublic LoadingIndicatorConfiguration getLoadingIndicatorConfiguration()
public ReconnectDialogConfiguration getReconnectDialogConfiguration()
public PushConfiguration getPushConfiguration()
Copyright © 2025. All rights reserved.