elemental.js.html

Class JsEntry

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

elemental.js.util.JsElementalBase

elemental.js.dom.JsElementalMixinBase

elemental.js.html.JsEntry

All Implemented Interfaces:

ElementalMixinBase, ElementTraversal, NodeSelector, EventTarget, Entry, ElementTimeControl, SVGExternalResourcesRequired, SVGFilterPrimitiveStandardAttributes, SVGFitToViewBox, SVGLangSpace, SVGLocatable, SVGStylable, SVGTests, SVGTransformable, SVGURIReference, SVGZoomAndPan, Indexable, IndexableInt, IndexableNumber, Mappable, Settable, SettableInt, SettableNumber

Direct Known Subclasses:

JsDirectoryEntry, JsFileEntry

public class JsEntry
extends JsElementalMixinBase
implements Entry

Field Summary

Fields inherited from interface elemental.svg.SVGZoomAndPan

SVG_ZOOMANDPAN_DISABLE, SVG_ZOOMANDPAN_MAGNIFY, SVG_ZOOMANDPAN_UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JsEntry()

Method Summary

Modifier and Type	Method and Description
void	copyTo(DirectoryEntry parent) Copy an entry to a different location on the file system.
void	copyTo(DirectoryEntry parent, String name) Copy an entry to a different location on the file system.
void	copyTo(DirectoryEntry parent, String name, EntryCallback successCallback) Copy an entry to a different location on the file system.
void	copyTo(DirectoryEntry parent, String name, EntryCallback successCallback, ErrorCallback errorCallback) Copy an entry to a different location on the file system.
JsDOMFileSystem	getFilesystem() The file system on which the entry resides.
String	getFullPath()
void	getMetadata(MetadataCallback successCallback) Look up metadata about this entry.
void	getMetadata(MetadataCallback successCallback, ErrorCallback errorCallback) Look up metadata about this entry.
String	getName() The name of the entry, excluding the path leading to it.
void	getParent() Look up the parent DirectoryEntry containing this entry.
void	getParent(EntryCallback successCallback) Look up the parent DirectoryEntry containing this entry.
void	getParent(EntryCallback successCallback, ErrorCallback errorCallback) Look up the parent DirectoryEntry containing this entry.
boolean	isDirectory() The entry is a directory.
boolean	isFile() The entry is a file.
void	moveTo(DirectoryEntry parent) Move an entry to a different location on the file system.
void	moveTo(DirectoryEntry parent, String name) Move an entry to a different location on the file system.
void	moveTo(DirectoryEntry parent, String name, EntryCallback successCallback) Move an entry to a different location on the file system.
void	moveTo(DirectoryEntry parent, String name, EntryCallback successCallback, ErrorCallback errorCallback) Move an entry to a different location on the file system.
void	remove(VoidCallback successCallback) Deletes a file or directory.
void	remove(VoidCallback successCallback, ErrorCallback errorCallback) Deletes a file or directory.
String	toURL() Returns a URL that can be used to identify this entry.

Methods inherited from class elemental.js.dom.JsElementalMixinBase

addEventListener, addEventListener, beginElement, beginElementAt, dispatchEvent, endElement, endElementAt, getAnimatedClassName, getAnimatedHeight, getAnimatedHref, getAnimatedResult, getAnimatedTransform, getAnimatedWidth, getAnimatedX, getAnimatedY, getBBox, getChildElementCount, getCTM, getExternalResourcesRequired, getFarthestViewportElement, getFirstElementChild, getLastElementChild, getNearestViewportElement, getNextElementSibling, getPresentationAttribute, getPreserveAspectRatio, getPreviousElementSibling, getRequiredExtensions, getRequiredFeatures, getScreenCTM, getSvgStyle, getSystemLanguage, getTransformToElement, getViewBox, getXmllang, getXmlspace, getZoomAndPan, hasExtension, querySelector, querySelectorAll, removeEventListener, removeEventListener, setXmllang, setXmlspace, setZoomAndPan

Methods inherited from class elemental.js.util.JsElementalBase

at, at, intAt, intAt, length, numberAt, numberAt, setAt, setAt, setAt, setAt, setAt, setAt

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface elemental.util.IndexableInt

intAt, length

Methods inherited from interface elemental.util.IndexableNumber

numberAt

Constructor Detail

JsEntry

protected JsEntry()

Method Detail

getFilesystem

public final JsDOMFileSystem getFilesystem()

Description copied from interface: Entry

The file system on which the entry resides.

Specified by:

getFilesystem in interface Entry

getFullPath

public final String getFullPath()

Specified by:

getFullPath in interface Entry

isDirectory

public final boolean isDirectory()

Description copied from interface: Entry

The entry is a directory.

Specified by:

isDirectory in interface Entry

isFile

public final boolean isFile()

Description copied from interface: Entry

The entry is a file.

Specified by:

isFile in interface Entry

getName

public final String getName()

Description copied from interface: Entry

The name of the entry, excluding the path leading to it.

Specified by:

getName in interface Entry

copyTo

public final void copyTo(DirectoryEntry parent)

Description copied from interface: Entry

Copy an entry to a different location on the file system. You cannot copy an entry inside itself if it is a directory nor can you copy it into its parent if a name different from its current one isn't provided. Directory copies are always recursive—that is, they copy all contents of the directory.

void vopyTo (
  (in DirectoryEntry parent, optional DOMString newName, optional EntryCallback successCallback, optional ErrorCallback errorCallback);
);

Parameter

parent

The directory to which to move the entry.

newName

The new name of the entry. Defaults to the entry's current name if unspecified.

successCallback

A callback that is called with the entry for the new object.

errorCallback

A callback that is called when errors happen.

Returns

void

Specified by:

copyTo in interface Entry

copyTo

public final void copyTo(DirectoryEntry parent,
                         String name)

Description copied from interface: Entry

Copy an entry to a different location on the file system. You cannot copy an entry inside itself if it is a directory nor can you copy it into its parent if a name different from its current one isn't provided. Directory copies are always recursive—that is, they copy all contents of the directory.

void vopyTo (
  (in DirectoryEntry parent, optional DOMString newName, optional EntryCallback successCallback, optional ErrorCallback errorCallback);
);

Parameter

parent

The directory to which to move the entry.

newName

The new name of the entry. Defaults to the entry's current name if unspecified.

successCallback

A callback that is called with the entry for the new object.

errorCallback

A callback that is called when errors happen.

Returns

void

Specified by:

copyTo in interface Entry

copyTo

public final void copyTo(DirectoryEntry parent,
                         String name,
                         EntryCallback successCallback)

Description copied from interface: Entry

Copy an entry to a different location on the file system. You cannot copy an entry inside itself if it is a directory nor can you copy it into its parent if a name different from its current one isn't provided. Directory copies are always recursive—that is, they copy all contents of the directory.

void vopyTo (
  (in DirectoryEntry parent, optional DOMString newName, optional EntryCallback successCallback, optional ErrorCallback errorCallback);
);

Parameter

parent

The directory to which to move the entry.

newName

The new name of the entry. Defaults to the entry's current name if unspecified.

successCallback

A callback that is called with the entry for the new object.

errorCallback

A callback that is called when errors happen.

Returns

void

Specified by:

copyTo in interface Entry

copyTo

public final void copyTo(DirectoryEntry parent,
                         String name,
                         EntryCallback successCallback,
                         ErrorCallback errorCallback)

Description copied from interface: Entry

Copy an entry to a different location on the file system. You cannot copy an entry inside itself if it is a directory nor can you copy it into its parent if a name different from its current one isn't provided. Directory copies are always recursive—that is, they copy all contents of the directory.

void vopyTo (
  (in DirectoryEntry parent, optional DOMString newName, optional EntryCallback successCallback, optional ErrorCallback errorCallback);
);

Parameter

parent

The directory to which to move the entry.

newName

The new name of the entry. Defaults to the entry's current name if unspecified.

successCallback

A callback that is called with the entry for the new object.

errorCallback

A callback that is called when errors happen.

Returns

void

Specified by:

copyTo in interface Entry

getMetadata

public final void getMetadata(MetadataCallback successCallback)

Description copied from interface: Entry

Look up metadata about this entry.

void getMetada (
  in MetadataCallback ErrorCallback
);

Parameter

successCallback

A callback that is called with the time of the last modification.

errorCallback

A callback that is called when errors happen.

Returns

void

Specified by:

getMetadata in interface Entry

getMetadata

public final void getMetadata(MetadataCallback successCallback,
                              ErrorCallback errorCallback)

Description copied from interface: Entry

Look up metadata about this entry.

void getMetada (
  in MetadataCallback ErrorCallback
);

Parameter

successCallback

A callback that is called with the time of the last modification.

errorCallback

A callback that is called when errors happen.

Returns

void

Specified by:

getMetadata in interface Entry

getParent

public final void getParent()

Description copied from interface: Entry

Look up the parent DirectoryEntry containing this entry. If this entry is the root of its filesystem, its parent is itself.

void getParent (
  (in EntryCallback successCallback, optional ErrorCallback errorCallback);
);

Parameter

parent

The directory to which to move the entry.

newName

The new name of the entry. Defaults to the entry's current name if unspecified.

successCellback

A callback that is called with the entry for the new object.

errorCallback

A callback that is called when errors happen.

Returns

void

Specified by:

getParent in interface Entry

getParent

public final void getParent(EntryCallback successCallback)

Description copied from interface: Entry

Look up the parent DirectoryEntry containing this entry. If this entry is the root of its filesystem, its parent is itself.

void getParent (
  (in EntryCallback successCallback, optional ErrorCallback errorCallback);
);

Parameter

parent

The directory to which to move the entry.

newName

The new name of the entry. Defaults to the entry's current name if unspecified.

successCellback

A callback that is called with the entry for the new object.

errorCallback

A callback that is called when errors happen.

Returns

void

Specified by:

getParent in interface Entry

getParent

public final void getParent(EntryCallback successCallback,
                            ErrorCallback errorCallback)

Description copied from interface: Entry

Look up the parent DirectoryEntry containing this entry. If this entry is the root of its filesystem, its parent is itself.

void getParent (
  (in EntryCallback successCallback, optional ErrorCallback errorCallback);
);

Parameter

parent

The directory to which to move the entry.

newName

The new name of the entry. Defaults to the entry's current name if unspecified.

successCellback

A callback that is called with the entry for the new object.

errorCallback

A callback that is called when errors happen.

Returns

void

Specified by:

getParent in interface Entry

moveTo

public final void moveTo(DirectoryEntry parent)

Description copied from interface: Entry

Move an entry to a different location on the file system. You cannot do the following:

• move a directory inside itself or to any child at any depth;
• move an entry into its parent if a name different from its current one isn't provided;
• move a file to a path occupied by a directory;
• move a directory to a path occupied by a file;
• move any element to a path occupied by a directory which is not empty.

Moving a file over an existing file replaces that existing file. A move of a directory on top of an existing empty directory replaces that directory.

void moveTo (
  (in DirectoryEntry parent, optional DOMString newName, optional EntryCallback successCallback, optional ErrorCallback errorCallback);
);

Parameter

parent

The directory to which to move the entry.

newName

The new name of the entry. Defaults to the entry's current name if unspecified.

successCallback

A callback that is called with the entry for the new object.

errorCallback

A callback that is called when errors happen.

Returns

void

Specified by:

moveTo in interface Entry

moveTo

public final void moveTo(DirectoryEntry parent,
                         String name)

Description copied from interface: Entry

Move an entry to a different location on the file system. You cannot do the following:

• move a directory inside itself or to any child at any depth;
• move an entry into its parent if a name different from its current one isn't provided;
• move a file to a path occupied by a directory;
• move a directory to a path occupied by a file;
• move any element to a path occupied by a directory which is not empty.

Moving a file over an existing file replaces that existing file. A move of a directory on top of an existing empty directory replaces that directory.

void moveTo (
  (in DirectoryEntry parent, optional DOMString newName, optional EntryCallback successCallback, optional ErrorCallback errorCallback);
);

Parameter

parent

The directory to which to move the entry.

newName

The new name of the entry. Defaults to the entry's current name if unspecified.

successCallback

A callback that is called with the entry for the new object.

errorCallback

A callback that is called when errors happen.

Returns

void

Specified by:

moveTo in interface Entry

moveTo

public final void moveTo(DirectoryEntry parent,
                         String name,
                         EntryCallback successCallback)

Description copied from interface: Entry

Move an entry to a different location on the file system. You cannot do the following:

• move a directory inside itself or to any child at any depth;
• move an entry into its parent if a name different from its current one isn't provided;
• move a file to a path occupied by a directory;
• move a directory to a path occupied by a file;
• move any element to a path occupied by a directory which is not empty.

Moving a file over an existing file replaces that existing file. A move of a directory on top of an existing empty directory replaces that directory.

void moveTo (
  (in DirectoryEntry parent, optional DOMString newName, optional EntryCallback successCallback, optional ErrorCallback errorCallback);
);

Parameter

parent

The directory to which to move the entry.

newName

The new name of the entry. Defaults to the entry's current name if unspecified.

successCallback

A callback that is called with the entry for the new object.

errorCallback

A callback that is called when errors happen.

Returns

void

Specified by:

moveTo in interface Entry

moveTo

public final void moveTo(DirectoryEntry parent,
                         String name,
                         EntryCallback successCallback,
                         ErrorCallback errorCallback)

Description copied from interface: Entry

Move an entry to a different location on the file system. You cannot do the following:

• move a directory inside itself or to any child at any depth;
• move an entry into its parent if a name different from its current one isn't provided;
• move a file to a path occupied by a directory;
• move a directory to a path occupied by a file;
• move any element to a path occupied by a directory which is not empty.

Moving a file over an existing file replaces that existing file. A move of a directory on top of an existing empty directory replaces that directory.

void moveTo (
  (in DirectoryEntry parent, optional DOMString newName, optional EntryCallback successCallback, optional ErrorCallback errorCallback);
);

Parameter

parent

The directory to which to move the entry.

newName

The new name of the entry. Defaults to the entry's current name if unspecified.

successCallback

A callback that is called with the entry for the new object.

errorCallback

A callback that is called when errors happen.

Returns

void

Specified by:

moveTo in interface Entry

remove

public final void remove(VoidCallback successCallback)

Description copied from interface: Entry

Deletes a file or directory. You cannot delete an empty directory or the root directory of a filesystem.

void remove (
  (in VoidCallback successCallback, optional ErrorCallback errorCallback);
);

Parameter

successCallback

A callback that is called with the entry for the new object.

errorCallback

A callback that is called when errors happen.

Returns

void

Specified by:

remove in interface Entry

remove

public final void remove(VoidCallback successCallback,
                         ErrorCallback errorCallback)

Description copied from interface: Entry

Deletes a file or directory. You cannot delete an empty directory or the root directory of a filesystem.

void remove (
  (in VoidCallback successCallback, optional ErrorCallback errorCallback);
);

Parameter

successCallback

A callback that is called with the entry for the new object.

errorCallback

A callback that is called when errors happen.

Returns

void

Specified by:

remove in interface Entry

toURL

public final String toURL()

Description copied from interface: Entry

Returns a URL that can be used to identify this entry. It has no specific expiration. Bcause it describes a location on disk, it is valid for as long as that location exists. Users can supply mimeType to simulate the optional mime-type header associated with HTTP downloads.

DOMString toURL (
  (in optional DOMString mimeType);
);

Parameter

mimeType

For a FileEntry, the mime type to be used to interpret the file, when loaded through this URL.

Returns

DOMString

Specified by:

toURL in interface Entry