Flash'In'App - ESNetscapePluginView - Instance Methods
setBackgroundColor:
Sets the color of the background which is reflected when nothing is loaded.
– (void)setBackgroundColor:(NSColor *)aColor;
Parameters
aColor – the color used to draw the background
backgroundColor
Returns background color of the view.
– (NSColor *)backgroundColor;
Return Value
The background color of the view.
initWithFrame:pluginPackage:MIMEType:attributeKeys:attributeValues:loadManually:
Initializes and returns a newly allocated ESNetscapePluginView object with a specified frame.
– (id)initWithFrame:(NSRect)frame
pluginPackage: (ESNetscapePlugin *)thePluginPackage
MIMEType: (NSString *)MIME
attributeKeys: (NSArray *)keys
attributeValues: (NSArray *)values
loadManually: (BOOL)loadManually;
Discussion
You shouldn't create the object of this type directly; use [ESFlashView initWithFrame:] instead.
isTransparent
Indicates whether the receiver is transparent.
– (BOOL)isTransparent;
Return Value
YES when the receiver is transparent, NO otherwise.
setBackgroundImage:
This method is used to set the background image which is reflected when nothing is loaded.
– (void) setBackgroundImage:(NSImage*)image;
Parameters
image – image to set as the receiver’s background color when nothing is loaded
backgroundImage
Identifies background image of the view, when nothing is loaded.
– (NSImage *)backgroundImage;
Return Value
The background image of the view, when nothing is loaded.
setSendRightClick:
Specifies if the mouse right-click will be redirected to plugin.
– (void) setSendRightClick:(BOOL)value;
Parameters
value – YES to specify that NetscapeView will redirect right mouse click to plugin, NO to permit redirection of right-click .
Discussion
I f you specify YES then plugin contextual menu will be displayed on right-click, if the plugin did not receive the right-click the menu will not be displayed. If you specify NO then you can set your own contextual menu with setMenu: (NSResponder)
sendRightClick
Returns a Boolean value that indicates whether the receiver redirects Right-button mouse click to plugin.
– (BOOL) sendRightClick;
Return Value
YES when ESNetscapePluginView redirects click of Right-button mouse to plugin; otherwise, NO.
snapshot
This method gets the snapshot of the current frame.
– (NSImage *) snapshot;
Return Value
The snapshot of the current frame.
loadMovie:atUrl:withBaseURL:
This method loads file into plugin.
– (BOOL) loadMovie:(NSData *)movieData atURL:(NSURL *)movieURL withBaseURL:(NSURL *)movieBaseURL;
Parameters
movieData - file contents
movieURL - URL to file
movieBaseURL - base URL to file (may be nil)
Return Value
YES if the file was loaded successfully; otherwise, NO.
loadMovieAtPath:
This method loads file at aPath to plugin.
- (BOOL) loadMovieAtPath:(NSString *)aPath;
Return Value
YES if the file was loaded successfully; otherwise, NO.
snapshotFromRect:
Gets the snapshot of the current frame in the specified rectangle (crop frame).
– (NSImage *) snapshotFromRect:(NSRect)sourceRect;
Return Value
The object with the image of the current frame (in the receiver's coordinates) will be returned.
start
This method loads the plugin.
– (BOOL)start;
Return Value
YES if loading is successful; otherwise, NO.
Discussion
This is done automatically with loadMovie:atURL:withBaseURL:
setDelegate:
Sets the receiver’s delegate to a given object or removes an existing delegate.
– (void) setDelegate:(id)value;
Parameters
value – the delegate for the receiver. Pass nil to remove an existing delegate.
Discussion
An ESNetscapePluginView object’s delegate is informed of various actions by the plugin through delegation messages.
delegate
Returns the receiver’s delegate.
– (id) delegate;
Return Value
The receiver’s delegate, or nil if it doesn’t have a delegate.
isStarted
Checks if plugin is running.
– (BOOL)isStarted;
Return value
YES when the receiver is started, NO otherwise.
setBaseURL:
Sets the new base URL.
– (void)setBaseURL:(NSURL *)theBaseURL;
Parameters
theBaseURL – value for new base URL (may be nil)
Discussion
It's the URL where resources will be searched for in case the movie loads them by relative paths; it's the host URL which user accesses to see the movie, not the one it is physically located at.
baseURL
Returns current value of base URL.
– (NSURL *) baseURL;
Return Value
The current value of base URL.
stop
The stop command stops and tries unloading plugin.
– (void)stop;
Discussion
By trying to unload the plugin we mean that in case there are several Netscape plugin views running that use the same plugin, it will be unloaded when all the views are stopped.
setSourceURL:
Sets the new URL to file (cannot be nil).
– (void)setSourceURL:(NSURL *)theSourceURL;
Parameters
theSourceURL – the source URL
sourceURL
Returns current value of URL to file.
- (NSURL *) sourceURL;
Return Value
The current value of URL to file.
See also: