org.formaria.swing.video
Class Video

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              org.formaria.swing.video.Video

All Implemented Interfaces:

java.awt.event.ComponentListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener

public class Video
extends javax.swing.JComponent
implements java.awt.event.ComponentListener

Video Playback Control

Copyright (c) Formaria Ltd., 2008, This software is licensed under the GNU Public License (GPL), please see license.txt for more details. If you make commercial use of this software you must purchase a commercial license from formaria.

$Revision: 1.14 $

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

protected Project

currentProject The owner project and the context in which this object operates.

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Video()
Create a new video component

Method Summary

java.awt.Component	add(java.awt.Component c) Add a component to the components layer.
void	add(java.awt.Component c, java.lang.Object constraint) Add a component to the components layer.
void	componentHidden(java.awt.event.ComponentEvent e) Invoked when the component has been made invisible.
void	componentMoved(java.awt.event.ComponentEvent e) Invoked when the component's position changes.
void	componentResized(java.awt.event.ComponentEvent e) Invoked when the component's size changes.
void	componentShown(java.awt.event.ComponentEvent e) Invoked when the component has been made visible.
void	destroy() Destroy the video controller and release its resources
boolean	getAutoStart() Get the autostart flag
boolean	getLoop() Get the loop flag
boolean	getShowController() Gets the show video controller flag
java.lang.String	getValue() Gets the name of the video or sound to play.
void	init() Performs any post creation initialisation of the control.
void	loop() Continuous playback of the video.
void	paintComponent(java.awt.Graphics g) Render the component
void	setAutoLoop(boolean autoLoop)
void	setAutoStart(boolean state) Set the autostart flag
void	setLoop(boolean value) Set the loop flag
void	setShowController(boolean display) Set and display the video controller
void	setValue(java.lang.String _fileName) Sets the name of the video or sound to play.
void	start() Starts playing the video
void	stop() Stops playback of the video.

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

currentProject

protected Project currentProject

The owner project and the context in which this object operates.

Constructor Detail

Video

public Video()

Create a new video component

Method Detail

paintComponent

public void paintComponent(java.awt.Graphics g)

Render the component

Overrides:

paintComponent in class javax.swing.JComponent

Parameters:

g - the graphics context

init

public void init()
          throws java.io.IOException

Performs any post creation initialisation of the control.

Throws:

java.io.IOException - problems setting up the video

destroy

public void destroy()

Destroy the video controller and release its resources

getLoop

public boolean getLoop()

Get the loop flag

Returns:

true if the video loops upon completion

setLoop

public void setLoop(boolean value)

Set the loop flag

Parameters:

value - true if the video loops upon completion

getValue

public java.lang.String getValue()

Gets the name of the video or sound to play.

Returns:

the name of the video to play.

setValue

public void setValue(java.lang.String _fileName)

Sets the name of the video or sound to play.

Parameters:

_fileName - name of the video to play.

setShowController

public void setShowController(boolean display)

Set and display the video controller

Parameters:

display - true to display the controller

getShowController

public boolean getShowController()

Gets the show video controller flag

Returns:

true if the playback controller is displayed

setAutoStart

public void setAutoStart(boolean state)

Set the autostart flag

Parameters:

state - true to autostart the video on display

getAutoStart

public boolean getAutoStart()

Get the autostart flag

Returns:

the current flag value

start

public void start()

Starts playing the video

loop

public void loop()

Continuous playback of the video.

stop

public void stop()

Stops playback of the video.

add

public java.awt.Component add(java.awt.Component c)

Add a component to the components layer. Due to limitations in JMF a heavy weight component is created for video playback. Therefore a heavyweight host for added components needs to be added or the video will obscure those components. The first component added to the video should be a panel

Overrides:

add in class java.awt.Container

Parameters:

c - the component to add

Returns:

the added component

add

public void add(java.awt.Component c,
                java.lang.Object constraint)

Add a component to the components layer. Due to limitations in JMF a heavy weight component is created for video playback. Therefore a heavyweight host for added components needs to be added or the video will obscure those components. The first component added to the video should be a panel

Overrides:

add in class java.awt.Container

Parameters:

c - the component to add

constraint - the layout constraints

componentResized

public void componentResized(java.awt.event.ComponentEvent e)

Invoked when the component's size changes.

Specified by:

componentResized in interface java.awt.event.ComponentListener

Parameters:

e - the resize event

componentMoved

public void componentMoved(java.awt.event.ComponentEvent e)

Invoked when the component's position changes.

Specified by:

componentMoved in interface java.awt.event.ComponentListener

Parameters:

e - the resize event

componentShown

public void componentShown(java.awt.event.ComponentEvent e)

Invoked when the component has been made visible.

Specified by:

componentShown in interface java.awt.event.ComponentListener

Parameters:

e - the resize event

componentHidden

public void componentHidden(java.awt.event.ComponentEvent e)

Invoked when the component has been made invisible.

Specified by:

componentHidden in interface java.awt.event.ComponentListener

Parameters:

e - the resize event

setAutoLoop

public void setAutoLoop(boolean autoLoop)