Interface InputUrlComponentProvider
-
@API(type=EXTENDABLE, src=PUBLIC) public interface InputUrlComponentProvider
Gives access to an URL chooser component similar to the ones in the application. The component can be added to Swing-based panels.- Since:
- 23.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addChangeListener(InputUrlComponentChangeListener listener)
Adds a listener that notifies when the url is changed.javax.swing.JComponent
getJComponent()
Get the Java component to add to the layout.java.net.URL
getUrl()
Gets the presentedURL
.java.lang.String
getUrlText()
Obtain the selected URL text from the url combobox.void
removeChangeListener(InputUrlComponentChangeListener listener)
Remove the listener that notifies when the url is changed.void
setEnabled(boolean enabled)
Enables or disable the components (the combo, the editor variables and the actions button)void
setUrl(java.net.URL url)
Sets theURL
to be presented.void
setUrlLabel(java.lang.String urlPresenterLabelText)
Changes the text of the label associated with the URL presenter component.void
setUrlText(java.lang.String newURL)
Set the new url directly inside the component.
-
-
-
Method Detail
-
getUrl
java.net.URL getUrl() throws java.net.MalformedURLException
Gets the presentedURL
.- Returns:
- The presented
URL
. Can benull
. - Throws:
java.net.MalformedURLException
- If the presented data cannot be converted to aURL
.
-
setUrl
void setUrl(java.net.URL url)
Sets theURL
to be presented.- Parameters:
url
- TheURL
to be presented.
-
getUrlText
java.lang.String getUrlText()
Obtain the selected URL text from the url combobox. It will return the exact value of the combobox, without expanding any editor variable.- Returns:
- Return the selected URL text from the url combobox.
-
setUrlText
void setUrlText(java.lang.String newURL)
Set the new url directly inside the component. Can contain unexpanded editor variables.- Parameters:
newURL
- The new URL.
-
setEnabled
void setEnabled(boolean enabled)
Enables or disable the components (the combo, the editor variables and the actions button)- Parameters:
enabled
-true
to enable.
-
setUrlLabel
void setUrlLabel(java.lang.String urlPresenterLabelText)
Changes the text of the label associated with the URL presenter component. By default the presented label isURL
- Parameters:
urlPresenterLabelText
- A new text for the label associated with the URL presenter component. Ifnull
, the label will be hidden.
-
getJComponent
javax.swing.JComponent getJComponent()
Get the Java component to add to the layout.- Returns:
- The java component to add to layout.
-
addChangeListener
void addChangeListener(InputUrlComponentChangeListener listener)
Adds a listener that notifies when the url is changed.- Parameters:
listener
- The listener that notifies when the url is changed.
-
removeChangeListener
void removeChangeListener(InputUrlComponentChangeListener listener)
Remove the listener that notifies when the url is changed.- Parameters:
listener
- The listener that notifies when the url is changed.
-
-