You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@wicket.apache.org by ts...@apache.org on 2015/05/25 06:59:13 UTC
wicket git commit: WICKET-5819 Javadoc for Video, Audio,
MediaComponent, Source, Track
Repository: wicket
Updated Branches:
refs/heads/WICKET-5819_Improvements bf881a3eb -> 7343727ce
WICKET-5819 Javadoc for Video, Audio, MediaComponent, Source, Track
Project: http://git-wip-us.apache.org/repos/asf/wicket/repo
Commit: http://git-wip-us.apache.org/repos/asf/wicket/commit/7343727c
Tree: http://git-wip-us.apache.org/repos/asf/wicket/tree/7343727c
Diff: http://git-wip-us.apache.org/repos/asf/wicket/diff/7343727c
Branch: refs/heads/WICKET-5819_Improvements
Commit: 7343727cee68ee60390339ca5a907f73e86ee5f6
Parents: bf881a3
Author: Tobias Soloschenko <ts...@apache.org>
Authored: Mon May 25 06:58:17 2015 +0200
Committer: Tobias Soloschenko <ts...@apache.org>
Committed: Mon May 25 06:58:17 2015 +0200
----------------------------------------------------------------------
.../apache/wicket/markup/html/image/Image.java | 50 ++++++--
.../apache/wicket/markup/html/image/Source.java | 45 ++++++-
.../markup/html/media/MediaComponent.java | 122 ++++++++++++++++---
.../apache/wicket/markup/html/media/Source.java | 83 ++++++++++++-
.../apache/wicket/markup/html/media/Track.java | 102 +++++++++++++++-
.../wicket/markup/html/media/audio/Audio.java | 100 ++++++++++++++-
.../wicket/markup/html/media/video/Video.java | 100 ++++++++++++++-
7 files changed, 552 insertions(+), 50 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/wicket/blob/7343727c/wicket-core/src/main/java/org/apache/wicket/markup/html/image/Image.java
----------------------------------------------------------------------
diff --git a/wicket-core/src/main/java/org/apache/wicket/markup/html/image/Image.java b/wicket-core/src/main/java/org/apache/wicket/markup/html/image/Image.java
index fdf1f76..f9484ed 100644
--- a/wicket-core/src/main/java/org/apache/wicket/markup/html/image/Image.java
+++ b/wicket-core/src/main/java/org/apache/wicket/markup/html/image/Image.java
@@ -59,17 +59,33 @@ public class Image extends WebComponent implements IResourceListener
* @see {@link #setCrossOrigin(Cors)}
*/
public enum Cors {
+ /**
+ * no authentication required
+ */
ANONYMOUS("anonymous"),
+ /**
+ * user credentials required
+ */
USE_CREDENTIALS("user-credentials"),
+ /**
+ * no cross origin
+ */
NO_CORS("");
private final String realName;
- private Cors(String realName) {
+ private Cors(String realName)
+ {
this.realName = realName;
}
- public String getRealName() {
+ /**
+ * Gets the real name for the cors option
+ *
+ * @return the real name
+ */
+ public String getRealName()
+ {
return realName;
}
}
@@ -247,8 +263,11 @@ public class Image extends WebComponent implements IResourceListener
/**
* @param resourceReference
* The resource reference to set.
+ * @param parameters
+ * the parameters to be applied to the localized image resource
*/
- public void setImageResourceReference(final ResourceReference resourceReference, final PageParameters parameters)
+ public void setImageResourceReference(final ResourceReference resourceReference,
+ final PageParameters parameters)
{
if (localizedImageResource != null)
{
@@ -385,7 +404,8 @@ public class Image extends WebComponent implements IResourceListener
buildSizesAttribute(tag);
Cors crossOrigin = getCrossOrigin();
- if (crossOrigin != null && Cors.NO_CORS != crossOrigin) {
+ if (crossOrigin != null && Cors.NO_CORS != crossOrigin)
+ {
tag.put("crossOrigin", crossOrigin.getRealName());
}
}
@@ -414,9 +434,8 @@ public class Image extends WebComponent implements IResourceListener
// If there are xValues set process them in the applied order to the srcset attribute.
if (xValues != null)
{
- xValue = xValues.size() > srcSetPosition &&
- xValues.get(srcSetPosition) != null ? " " +
- xValues.get(srcSetPosition) : "";
+ xValue = xValues.size() > srcSetPosition && xValues.get(srcSetPosition) != null
+ ? " " + xValues.get(srcSetPosition) : "";
}
tag.put("srcset", (srcset != null ? srcset + ", " : "") + tag.getAttribute("src") +
xValue);
@@ -561,7 +580,8 @@ public class Image extends WebComponent implements IResourceListener
*
* @return the cross origins settings
*/
- public Cors getCrossOrigin() {
+ public Cors getCrossOrigin()
+ {
return crossOrigin;
}
@@ -569,17 +589,21 @@ public class Image extends WebComponent implements IResourceListener
* Sets the cross origin settings<br>
* <br>
*
- * <b>ANONYMOUS</b>: Cross-origin CORS requests for the element will not have the credentials flag set.<br>
+ * <b>ANONYMOUS</b>: Cross-origin CORS requests for the element will not have the credentials
+ * flag set.<br>
* <br>
- * <b>USE_CREDENTIALS</b>: Cross-origin CORS requests for the element will have the credentials flag set.<br>
+ * <b>USE_CREDENTIALS</b>: Cross-origin CORS requests for the element will have the credentials
+ * flag set.<br>
* <br>
- * <b>no_cores</b>: The empty string is also a valid keyword, and maps to the Anonymous state. The attribute's invalid value default is the
- * Anonymous state. The missing value default, used when the attribute is omitted, is the No CORS state
+ * <b>no_cores</b>: The empty string is also a valid keyword, and maps to the Anonymous state.
+ * The attribute's invalid value default is the Anonymous state. The missing value default, used
+ * when the attribute is omitted, is the No CORS state
*
* @param crossOrigin
* the cross origins settings to set
*/
- public void setCrossOrigin(Cors crossOrigin) {
+ public void setCrossOrigin(Cors crossOrigin)
+ {
this.crossOrigin = crossOrigin;
}
http://git-wip-us.apache.org/repos/asf/wicket/blob/7343727c/wicket-core/src/main/java/org/apache/wicket/markup/html/image/Source.java
----------------------------------------------------------------------
diff --git a/wicket-core/src/main/java/org/apache/wicket/markup/html/image/Source.java b/wicket-core/src/main/java/org/apache/wicket/markup/html/image/Source.java
index 76ea0de..713309a 100644
--- a/wicket-core/src/main/java/org/apache/wicket/markup/html/image/Source.java
+++ b/wicket-core/src/main/java/org/apache/wicket/markup/html/image/Source.java
@@ -40,6 +40,10 @@ public class Source extends Image
private String media = null;
/**
+ * Creates a source for a picture
+ *
+ * @param id
+ * the component id
* @see org.apache.wicket.markup.html.image.Image
*/
protected Source(final String id)
@@ -48,6 +52,12 @@ public class Source extends Image
}
/**
+ * Creates a source for a picture
+ *
+ * @param id
+ * the component id
+ * @param resourceReferences
+ * the resource references applied to the source in the given order
* @see org.apache.wicket.markup.html.image.Image
*/
public Source(final String id, final ResourceReference... resourceReferences)
@@ -56,6 +66,14 @@ public class Source extends Image
}
/**
+ * Creates a source for a picture
+ *
+ * @param id
+ * the component id
+ * @param resourceParameters
+ * the resource parameters applied to the localized image resource
+ * @param resourceReferences
+ * the resource references applied to the source in the given order
* @see org.apache.wicket.markup.html.image.Image
*/
public Source(final String id, PageParameters resourceParameters,
@@ -65,6 +83,12 @@ public class Source extends Image
}
/**
+ * Creates a source for a picture
+ *
+ * @param id
+ * the component id
+ * @param imageResources
+ * the image resources applied to the source in the given order
* @see org.apache.wicket.markup.html.image.Image
*/
public Source(final String id, final IResource... imageResources)
@@ -73,6 +97,12 @@ public class Source extends Image
}
/**
+ * Creates a source for a picture
+ *
+ * @param id
+ * the component id
+ * @param model
+ * the internally used model
* @see org.apache.wicket.Component#Component(String, IModel)
*/
public Source(final String id, final IModel<?> model)
@@ -81,6 +111,12 @@ public class Source extends Image
}
/**
+ * Creates a source for a picture
+ *
+ * @param id
+ * the component id
+ * @param string
+ * the string used as model
* @see org.apache.wicket.markup.html.image.Image
*/
public Source(final String id, final String string)
@@ -124,15 +160,18 @@ public class Source extends Image
* Unsupported for source tag
*/
@Override
- public void setCrossOrigin(Cors crossorigin) {
- throw new UnsupportedOperationException("It is not allowed to set the crossorigin attribute for source tag");
+ public void setCrossOrigin(Cors crossorigin)
+ {
+ throw new UnsupportedOperationException(
+ "It is not allowed to set the crossorigin attribute for source tag");
}
/**
* Unsupported for source tag
*/
@Override
- public final Cors getCrossOrigin() {
+ public final Cors getCrossOrigin()
+ {
return null;
}
}
http://git-wip-us.apache.org/repos/asf/wicket/blob/7343727c/wicket-core/src/main/java/org/apache/wicket/markup/html/media/MediaComponent.java
----------------------------------------------------------------------
diff --git a/wicket-core/src/main/java/org/apache/wicket/markup/html/media/MediaComponent.java b/wicket-core/src/main/java/org/apache/wicket/markup/html/media/MediaComponent.java
index a6ef048..96d757b 100755
--- a/wicket-core/src/main/java/org/apache/wicket/markup/html/media/MediaComponent.java
+++ b/wicket-core/src/main/java/org/apache/wicket/markup/html/media/MediaComponent.java
@@ -43,9 +43,19 @@ public abstract class MediaComponent extends WebMarkupContainer
*
* @see {@link #setCrossOrigin(Cors)}
*/
- public enum Cors
- {
- ANONYMOUS("anonymous"), USER_CREDENTIALS("user-credentials"), NO_CORS("");
+ public enum Cors {
+ /**
+ * no authentication required
+ */
+ ANONYMOUS("anonymous"),
+ /**
+ * user credentials required
+ */
+ USER_CREDENTIALS("user-credentials"),
+ /**
+ * no cross origin
+ */
+ NO_CORS("");
private final String realName;
@@ -54,6 +64,11 @@ public abstract class MediaComponent extends WebMarkupContainer
this.realName = realName;
}
+ /**
+ * Gets the real name for the cors option
+ *
+ * @return the real name
+ */
public String getRealName()
{
return realName;
@@ -65,17 +80,32 @@ public abstract class MediaComponent extends WebMarkupContainer
*
* @see {@link #setPreload(Preload)}
*/
- public enum Preload
- {
- NONE("none"), METADATA("metadata"), AUTO("auto");
+ public enum Preload {
+ /**
+ * preloads nothing
+ */
+ NONE("none"),
+ /**
+ * preloads only meta data like first picture, etc.
+ */
+ METADATA("metadata"),
+ /**
+ * auto detection what is going to be preload
+ */
+ AUTO("auto");
- public final String realName;
+ private final String realName;
private Preload(String realname)
{
realName = realname;
}
+ /**
+ * Gets the real name for the preload option
+ *
+ * @return the real name
+ */
public String getRealName()
{
return realName;
@@ -131,47 +161,107 @@ public abstract class MediaComponent extends WebMarkupContainer
}
/**
- * Constructor.
+ * Creates a media component
*
* @param id
* The component id
* @param resourceReference
+ * the package resource reference of the media file
*/
public MediaComponent(String id, PackageResourceReference resourceReference)
{
this(id, null, null, null, resourceReference);
}
- public MediaComponent(String id, IModel<?> model,
- PackageResourceReference resourceReference)
+ /**
+ * Creates a media component
+ *
+ * @param id
+ * The component id
+ * @param model
+ * the internally used model
+ * @param resourceReference
+ * the package resource reference of the media file
+ */
+ public MediaComponent(String id, IModel<?> model, PackageResourceReference resourceReference)
{
this(id, model, null, null, resourceReference);
}
- public MediaComponent(String id,
- PackageResourceReference resourceReference,
+ /**
+ * Creates a media component
+ *
+ * @param id
+ * The component id
+ * @param resourceReference
+ * the package resource reference of the media file
+ * @param pageParameters
+ * the page parameters to be used to be prepended to the media URL
+ */
+ public MediaComponent(String id, PackageResourceReference resourceReference,
PageParameters pageParameters)
{
this(id, null, null, pageParameters, resourceReference);
}
- public MediaComponent(String id, IModel<?> model,
- PackageResourceReference resourceReference,
+ /**
+ * Creates a media component
+ *
+ * @param id
+ * The component id
+ * @param model
+ * the internally used model
+ * @param resourceReference
+ * the package resource reference of the media file
+ * @param pageParameters
+ * the page parameters to be used to be prepended to the media URL
+ */
+ public MediaComponent(String id, IModel<?> model, PackageResourceReference resourceReference,
PageParameters pageParameters)
{
this(id, model, null, pageParameters, resourceReference);
}
+ /**
+ * Creates a media component
+ *
+ * @param id
+ * The component id
+ * @param url
+ * an external URL to be used for the media component
+ */
public MediaComponent(String id, String url)
{
this(id, null, url, null, null);
}
+ /**
+ * Creates a media component
+ *
+ * @param id
+ * The component id
+ * @param model
+ * the internally used model
+ * @param url
+ * an external URL to be used for the media component
+ */
public MediaComponent(String id, IModel<?> model, String url)
{
this(id, model, url, null, null);
}
+ /**
+ * Creates a media component
+ *
+ * @param id
+ * The component id
+ * @param model
+ * the internally used model
+ * @param url
+ * an external URL to be used for the media component
+ * @param pageParameters
+ * the page parameters to be used to be prepended to the media URL
+ */
public MediaComponent(String id, IModel<?> model, String url, PageParameters pageParameters)
{
this(id, model, url, pageParameters, null);
@@ -201,8 +291,8 @@ public abstract class MediaComponent extends WebMarkupContainer
if (resourceReference != null)
{
- CharSequence urlToMediaReference = RequestCycle.get().urlFor(
- resourceReference, pageParameters);
+ CharSequence urlToMediaReference = RequestCycle.get().urlFor(resourceReference,
+ pageParameters);
tag.put("src", urlToMediaReference + timeManagement);
}
else if (url != null)
http://git-wip-us.apache.org/repos/asf/wicket/blob/7343727c/wicket-core/src/main/java/org/apache/wicket/markup/html/media/Source.java
----------------------------------------------------------------------
diff --git a/wicket-core/src/main/java/org/apache/wicket/markup/html/media/Source.java b/wicket-core/src/main/java/org/apache/wicket/markup/html/media/Source.java
index fb2c467..4abdca9 100755
--- a/wicket-core/src/main/java/org/apache/wicket/markup/html/media/Source.java
+++ b/wicket-core/src/main/java/org/apache/wicket/markup/html/media/Source.java
@@ -48,52 +48,122 @@ public class Source extends WebMarkupContainer
private final String url;
+ /**
+ * Creates a source
+ *
+ * @param id
+ * the component id
+ */
public Source(String id)
{
this(id, null, null, null, null);
}
+ /**
+ * Creates a source
+ *
+ * @param id
+ * the component id
+ * @param model
+ * the internally used model
+ */
public Source(String id, IModel<?> model)
{
this(id, model, null, null, null);
}
+ /**
+ * Creates a source
+ *
+ * @param id
+ * the component id
+ * @param resourceReference
+ * the resource reference to provide the source data
+ */
public Source(String id, PackageResourceReference resourceReference)
{
this(id, null, null, null, resourceReference);
}
- public Source(String id, IModel<?> model,
- PackageResourceReference resourceReference)
+ /**
+ * Creates a source
+ *
+ * @param id
+ * the component id
+ * @param model
+ * the internally used model
+ * @param resourceReference
+ * the resource reference to provide the source data
+ */
+ public Source(String id, IModel<?> model, PackageResourceReference resourceReference)
{
this(id, model, null, null, resourceReference);
}
+ /**
+ * Creates a source
+ *
+ * @param id
+ * the component id
+ * @param pageParameters
+ * the the page parameters applied to the source URL
+ * @param resourceReference
+ * the resource reference to provide the source data
+ */
public Source(String id, PackageResourceReference resourceReference,
PageParameters pageParameters)
{
this(id, null, null, pageParameters, resourceReference);
}
- public Source(String id, IModel<?> model,
- PackageResourceReference resourceReference,
+ /**
+ * Creates a source
+ *
+ * @param id
+ * the component id
+ * @param model
+ * the internally used model
+ * @param resourceReference
+ * the resource reference to provide the source data
+ * @param pageParameters
+ * the the page parameters applied to the source URL
+ */
+ public Source(String id, IModel<?> model, PackageResourceReference resourceReference,
PageParameters pageParameters)
{
this(id, model, null, pageParameters, resourceReference);
}
+ /**
+ * Creates a source
+ *
+ * @param id
+ * the component id
+ * @param url
+ * an external URL to provide the source information
+ */
public Source(String id, String url)
{
this(id, null, url, null, null);
}
+ /**
+ * Creates a source
+ *
+ * @param id
+ * the component id
+ * @param model
+ * the internally used model
+ * @param url
+ * an external URL to provide the source information
+ */
public Source(String id, IModel<?> model, String url)
{
this(id, model, url, null, null);
}
private Source(String id, IModel<?> model, String url, PageParameters pageParameters,
- PackageResourceReference resourceReference)
+ PackageResourceReference resourceReference)
{
super(id, model);
this.url = url;
@@ -111,7 +181,8 @@ public class Source extends WebMarkupContainer
{
CharSequence url = RequestCycle.get().urlFor(resourceReference, pageParameters);
tag.put("src", url);
- } else if (url != null)
+ }
+ else if (url != null)
{
tag.put("src", url);
}
http://git-wip-us.apache.org/repos/asf/wicket/blob/7343727c/wicket-core/src/main/java/org/apache/wicket/markup/html/media/Track.java
----------------------------------------------------------------------
diff --git a/wicket-core/src/main/java/org/apache/wicket/markup/html/media/Track.java b/wicket-core/src/main/java/org/apache/wicket/markup/html/media/Track.java
index c41217a..9b053bf 100755
--- a/wicket-core/src/main/java/org/apache/wicket/markup/html/media/Track.java
+++ b/wicket-core/src/main/java/org/apache/wicket/markup/html/media/Track.java
@@ -39,10 +39,27 @@ public class Track extends WebMarkupContainer
/**
* To be used for the kind attribute
*/
- public enum Kind
- {
- SUBTITLES("subtitles"), CAPTIONS("captions"), DESCRIPTIONS("descriptions"), CHAPTERS(
- "chapters"), METADATA("metadata");
+ public enum Kind {
+ /**
+ * the track is used for subtitles
+ */
+ SUBTITLES("subtitles"),
+ /**
+ * the track is used for captions
+ */
+ CAPTIONS("captions"),
+ /**
+ * the track is used for descriptions
+ */
+ DESCRIPTIONS("descriptions"),
+ /**
+ * the track is used for chapters
+ */
+ CHAPTERS("chapters"),
+ /**
+ * the track is used to provide metadata
+ */
+ METADATA("metadata");
private String realName;
@@ -51,6 +68,11 @@ public class Track extends WebMarkupContainer
this.realName = realName;
}
+ /**
+ * The real name of the kind
+ *
+ * @return the real name
+ */
public String getRealName()
{
return realName;
@@ -71,42 +93,114 @@ public class Track extends WebMarkupContainer
private final PageParameters pageParameters;
+ /**
+ * Creates a track
+ *
+ * @param id
+ * the component id
+ */
public Track(String id)
{
this(id, null, null, null, null);
}
+ /**
+ * Creates a track
+ *
+ * @param id
+ * the component id
+ * @param model
+ * the internally used model
+ */
public Track(String id, IModel<?> model)
{
this(id, model, null, null, null);
}
+ /**
+ * Creates a track
+ *
+ * @param id
+ * the component id
+ * @param resourceReference
+ * the resource reference to provide track information - like .vtt
+ */
public Track(String id, ResourceReference resourceReference)
{
this(id, null, null, null, resourceReference);
}
+ /**
+ * Creates a track
+ *
+ * @param id
+ * the component id
+ * @param model
+ * the internally used model
+ * @param resourceReference
+ * the resource reference to provide track information - like .vtt
+ */
public Track(String id, IModel<?> model, ResourceReference resourceReference)
{
this(id, model, null, null, resourceReference);
}
+ /**
+ * Creates a track
+ *
+ * @param id
+ * the component id
+ * @param resourceReference
+ * the resource reference to provide track information - like .vtt
+ * @param pageParameters
+ * the page parameters applied to the track URL
+ */
public Track(String id, ResourceReference resourceReference, PageParameters pageParameters)
{
this(id, null, null, pageParameters, resourceReference);
}
+ /**
+ * Creates a track
+ *
+ * @param id
+ * the component id
+ * @param model
+ * the internally used model
+ * @param resourceReference
+ * the resource reference to provide track information - like .vtt
+ * @param pageParameters
+ * the page parameters applied to the track URL
+ */
public Track(String id, IModel<?> model, ResourceReference resourceReference,
PageParameters pageParameters)
{
this(id, model, null, pageParameters, resourceReference);
}
+ /**
+ * Creates a track
+ *
+ * @param id
+ * the component id
+ * @param url
+ * an external URL to provide the track information
+ */
public Track(String id, String url)
{
this(id, null, url, null, null);
}
+ /**
+ * Creates a track
+ *
+ * @param id
+ * the component id
+ * @param model
+ * the internally used model
+ * @param url
+ * an external URL to provide the track information
+ */
public Track(String id, IModel<?> model, String url)
{
this(id, model, url, null, null);
http://git-wip-us.apache.org/repos/asf/wicket/blob/7343727c/wicket-core/src/main/java/org/apache/wicket/markup/html/media/audio/Audio.java
----------------------------------------------------------------------
diff --git a/wicket-core/src/main/java/org/apache/wicket/markup/html/media/audio/Audio.java b/wicket-core/src/main/java/org/apache/wicket/markup/html/media/audio/Audio.java
index aa6e782..2b7cb61 100755
--- a/wicket-core/src/main/java/org/apache/wicket/markup/html/media/audio/Audio.java
+++ b/wicket-core/src/main/java/org/apache/wicket/markup/html/media/audio/Audio.java
@@ -33,55 +33,147 @@ public class Audio extends MediaComponent
{
private static final long serialVersionUID = 1L;
+ /**
+ * Creates an audio component
+ *
+ * @param id
+ * the component id
+ */
public Audio(String id)
{
super(id);
}
+ /**
+ * Creates an audio component
+ *
+ * @param id
+ * the component id
+ * @param model
+ * the internally used model
+ */
public Audio(String id, IModel<?> model)
{
super(id, model);
}
+ /**
+ * Creates an audio component
+ *
+ * @param id
+ * the component id
+ * @param resourceReference
+ * the package resource reference of the audio file
+ */
public Audio(String id, PackageResourceReference resourceReference)
{
super(id, resourceReference);
}
- public Audio(String id, IModel<?> model,
- PackageResourceReference resourceReference)
+ /**
+ * Creates an audio component
+ *
+ * @param id
+ * the component id
+ * @param model
+ * the internally used model
+ * @param resourceReference
+ * the package resource reference of the audio file
+ */
+ public Audio(String id, IModel<?> model, PackageResourceReference resourceReference)
{
super(id, model, resourceReference);
}
+ /**
+ * Creates an audio component
+ *
+ * @param id
+ * the component id
+ * @param resourceReference
+ * the package resource reference of the audio file
+ * @param pageParameters
+ * the page parameters to be used to be prepended to the audio URL
+ */
public Audio(String id, PackageResourceReference resourceReference,
PageParameters pageParameters)
{
super(id, resourceReference, pageParameters);
}
- public Audio(String id, IModel<?> model,
- PackageResourceReference resourceReference,
+ /**
+ * Creates an audio component
+ *
+ * @param id
+ * the component id
+ * @param model
+ * the internally used model
+ * @param resourceReference
+ * the package resource reference of the audio file
+ * @param pageParameters
+ * the page parameters to be used to be prepended to the audio URL
+ */
+ public Audio(String id, IModel<?> model, PackageResourceReference resourceReference,
PageParameters pageParameters)
{
super(id, model, resourceReference, pageParameters);
}
+ /**
+ * Creates an audio component
+ *
+ * @param id
+ * the component id
+ * @param url
+ * an external URL to be used for the audio component
+ */
public Audio(String id, String url)
{
super(id, url);
}
+ /**
+ * Creates an audio component
+ *
+ * @param id
+ * the component id
+ * @param model
+ * the internally used model
+ * @param url
+ * an external URL to be used for the audio component
+ */
public Audio(String id, IModel<?> model, String url)
{
super(id, model, url);
}
+ /**
+ * Creates an audio component
+ *
+ * @param id
+ * the component id
+ * @param url
+ * an external URL to be used for the audio component
+ * @param pageParameters
+ * the page parameters to be used to be prepended to the audio URL
+ */
public Audio(String id, String url, PageParameters pageParameters)
{
super(id, null, url, pageParameters);
}
+ /**
+ * Creates an audio component
+ *
+ * @param id
+ * the component id
+ * @param model
+ * the internally used model
+ * @param url
+ * an external URL to be used for the audio component
+ * @param pageParameters
+ * the page parameters to be used to be prepended to the audio URL
+ */
public Audio(String id, IModel<?> model, String url, PageParameters pageParameters)
{
super(id, model, url, pageParameters);
http://git-wip-us.apache.org/repos/asf/wicket/blob/7343727c/wicket-core/src/main/java/org/apache/wicket/markup/html/media/video/Video.java
----------------------------------------------------------------------
diff --git a/wicket-core/src/main/java/org/apache/wicket/markup/html/media/video/Video.java b/wicket-core/src/main/java/org/apache/wicket/markup/html/media/video/Video.java
index 7e685b9..c792356 100755
--- a/wicket-core/src/main/java/org/apache/wicket/markup/html/media/video/Video.java
+++ b/wicket-core/src/main/java/org/apache/wicket/markup/html/media/video/Video.java
@@ -43,55 +43,147 @@ public class Video extends MediaComponent
private PageParameters posterPageParameters;
+ /**
+ * Creates a video component
+ *
+ * @param id
+ * the component id
+ */
public Video(String id)
{
super(id);
}
+ /**
+ * Creates a video component
+ *
+ * @param id
+ * the component id
+ * @param model
+ * the internally used model
+ */
public Video(String id, IModel<?> model)
{
super(id, model);
}
+ /**
+ * Creates a video component
+ *
+ * @param id
+ * the component id
+ * @param resourceReference
+ * the package resource reference of the video file
+ */
public Video(String id, PackageResourceReference resourceReference)
{
super(id, resourceReference);
}
- public Video(String id, IModel<?> model,
- PackageResourceReference resourceReference)
+ /**
+ * Creates a video component
+ *
+ * @param id
+ * the component id
+ * @param model
+ * the internally used model
+ * @param resourceReference
+ * the package resource reference of the video file
+ */
+ public Video(String id, IModel<?> model, PackageResourceReference resourceReference)
{
super(id, model, resourceReference);
}
+ /**
+ * Creates a media component
+ *
+ * @param id
+ * the component id
+ * @param resourceReference
+ * the package resource reference of the video file
+ * @param pageParameters
+ * the page parameters to be used to be prepended to the video URL
+ */
public Video(String id, PackageResourceReference resourceReference,
PageParameters pageParameters)
{
super(id, resourceReference, pageParameters);
}
- public Video(String id, IModel<?> model,
- PackageResourceReference resourceReference,
+ /**
+ * Creates a video component
+ *
+ * @param id
+ * the component id
+ * @param model
+ * the internally used model
+ * @param resourceReference
+ * the package resource reference of the video file
+ * @param pageParameters
+ * the page parameters to be used to be prepended to the video URL
+ */
+ public Video(String id, IModel<?> model, PackageResourceReference resourceReference,
PageParameters pageParameters)
{
super(id, model, resourceReference, pageParameters);
}
+ /**
+ * Creates a video component
+ *
+ * @param id
+ * the component id
+ * @param url
+ * an external URL to be used for the video component
+ */
public Video(String id, String url)
{
super(id, url);
}
+ /**
+ * Creates a video component
+ *
+ * @param id
+ * the component id
+ * @param model
+ * the internally used model
+ * @param url
+ * an external URL to be used for the video component
+ */
public Video(String id, IModel<?> model, String url)
{
super(id, model, url);
}
+ /**
+ * Creates a video component
+ *
+ * @param id
+ * the component id
+ * @param url
+ * an external URL to be used for the video component
+ * @param pageParameters
+ * the page parameters to be used to be prepended to the video URL
+ */
public Video(String id, String url, PageParameters pageParameters)
{
super(id, null, url, pageParameters);
}
+ /**
+ * Creates a video component
+ *
+ * @param id
+ * the component id
+ * @param model
+ * the internally used model
+ * @param url
+ * an external URL to be used for the video component
+ * @param pageParameters
+ * the page parameters to be used to be prepended to the video URL
+ */
public Video(String id, IModel<?> model, String url, PageParameters pageParameters)
{
super(id, model, url, pageParameters);