Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecating Flash component. #12348

Merged
merged 1 commit into from
Jul 26, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 98 additions & 0 deletions client/src/main/java/com/vaadin/client/ui/VFlash.java
Original file line number Diff line number Diff line change
Expand Up @@ -21,71 +21,155 @@
import com.google.gwt.user.client.ui.HTML;
import com.vaadin.client.WidgetUtil;

/**
* Widget class for the Flash component.
*
* @author Vaadin Ltd
*
* @deprecated No modern browsers support Flash content anymore.
*/
@Deprecated
public class VFlash extends HTML {

/** Default classname for this widget. */
public static final String CLASSNAME = "v-flash";

/** @see #setSource(String) */
protected String source;
/** @see #setAlternateText(String) */
protected String altText;
/** @see #setClassId(String) */
protected String classId;
/** @see #setCodebase(String) */
protected String codebase;
/** @see #setCodetype(String) */
protected String codetype;
/** @see #setStandby(String) */
protected String standby;
/** @see #setArchive(String) */
protected String archive;
/** @see #setEmbedParams(Map) */
protected Map<String, String> embedParams = new HashMap<>();
/** Determines whether {@link #rebuildIfNeeded()} does anything. */
protected boolean needsRebuild = false;
/** @see #setWidth(String) */
protected String width;
/** @see #setHeight(String) */
protected String height;

private int slotOffsetHeight = -1;
private int slotOffsetWidth = -1;

/**
* Default constructor.
*/
public VFlash() {
setStyleName(CLASSNAME);
}

/**
* Set the resource representing the Flash content that should be displayed.
*
* @param source
* the resource URL
*/
public void setSource(String source) {
if (this.source != source) {
this.source = source;
needsRebuild = true;
}
}

/**
* Sets this component's alternate text that can be presented instead of the
* component's normal content for accessibility purposes.
*
* @param altText
* a short, human-readable description of this component's
* content
*/
public void setAlternateText(String altText) {
if (this.altText != altText) {
this.altText = altText;
needsRebuild = true;
}
}

/**
* Set the class id that is required for ActiveX to recognize the flash.
* This is a predefined value which ActiveX recognizes and must be the given
* value.
*
* @param classId
* the classId
*/
public void setClassId(String classId) {
if (this.classId != classId) {
this.classId = classId;
needsRebuild = true;
}
}

/**
* This attribute specifies the base path used to resolve relative URIs
* specified by the classid, data, and archive attributes. The default value
* is the base URI of the current document.
*
* @param codebase
* The base path
*
* @see #setClassId(String)
* @see #setArchive(String)
*/
public void setCodebase(String codebase) {
if (this.codebase != codebase) {
this.codebase = codebase;
needsRebuild = true;
}
}

/**
* This attribute specifies the content type of data expected when
* downloading the object specified by classid. This attribute is optional
* but recommended when classid is specified since it allows the user agent
* to avoid loading information for unsupported content types. The default
* value is the value of the type attribute.
*
* @param codetype
* the codetype to set.
*/
public void setCodetype(String codetype) {
if (this.codetype != codetype) {
this.codetype = codetype;
needsRebuild = true;
}
}

/**
* Sets standby.
*
* @param standby
* the standby text
*/
public void setStandby(String standby) {
if (this.standby != standby) {
this.standby = standby;
needsRebuild = true;
}
}

/**
* This attribute may be used to specify a space-separated list of URIs for
* archives containing resources relevant to the object, which may include
* the resources specified by the classid and data attributes. Preloading
* archives will generally result in reduced load times for objects.
* Archives specified as relative URIs should be interpreted relative to the
* codebase attribute.
*
* @param archive
* Space-separated list of URIs with resources relevant to the
* object
*/
public void setArchive(String archive) {
if (this.archive != archive) {
this.archive = archive;
Expand Down Expand Up @@ -122,6 +206,15 @@ public void setHeight(String height) {
}
}

/**
* Sets the map of object parameters. Parameters are optional information,
* and they are passed to the instantiated object. Parameters are are stored
* as name value pairs. Calling this method for a second time overrides the
* previously given map.
*
* @param params
* the parameter map
*/
public void setEmbedParams(Map<String, String> params) {
if (params == null) {
if (!embedParams.isEmpty()) {
Expand Down Expand Up @@ -159,6 +252,11 @@ public void setSlotHeightAndWidth(int slotOffsetHeight,

}

/**
* Creates the embed String.
*
* @return the embed String
*/
protected String createFlashEmbed() {
/*
* To ensure cross-browser compatibility we are using the twice-cooked
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@
import com.vaadin.shared.ui.Connect;
import com.vaadin.shared.ui.flash.FlashState;

/**
* A connector class for the Flash component.
*
* @author Vaadin Ltd
*
* @deprecated No modern browsers support Flash content anymore.
*/
@Deprecated
@Connect(com.vaadin.ui.Flash.class)
public class FlashConnector extends AbstractComponentConnector {

Expand Down
5 changes: 4 additions & 1 deletion server/src/main/java/com/vaadin/ui/Flash.java
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,9 @@
*
* @author Vaadin Ltd.
* @since 7.0
* @deprecated No modern browsers support Flash content anymore.
*/
@SuppressWarnings("serial")
@Deprecated
public class Flash extends AbstractEmbedded {

/**
Expand Down Expand Up @@ -212,6 +213,8 @@ public void setParameter(String name, String value) {
* information, and they are passed to the instantiated object. Parameters
* are are stored as name value pairs.
*
* @param name
* name of the parameter
* @return the Value of parameter or null if not found.
*/
public String getParameter(String name) {
Expand Down