TV-Browser 3.3.3 API

util.ui
Class ChannelLabel

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JLabel
                  extended by util.ui.ChannelLabel
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible, javax.swing.SwingConstants
Direct Known Subclasses:
ProgramTableChannelLabel

public class ChannelLabel
extends javax.swing.JLabel

A Label for Channels. It shows the Icon and/or the Channel-Name

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class javax.swing.JLabel
javax.swing.JLabel.AccessibleJLabel
 
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
(package private) static javax.swing.Icon DEFAULT_ICON
          default channel icon, already prepared for right size
 
Fields inherited from class javax.swing.JLabel
labelFor
 
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 javax.swing.SwingConstants
BOTTOM, CENTER, EAST, HORIZONTAL, LEADING, LEFT, NEXT, NORTH, NORTH_EAST, NORTH_WEST, PREVIOUS, RIGHT, SOUTH, SOUTH_EAST, SOUTH_WEST, TOP, TRAILING, VERTICAL, WEST
 
Fields inherited from interface java.awt.image.ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
ChannelLabel()
          Creates the ChannelLabel
ChannelLabel(boolean channelIconsVisible)
          Creates the ChannelLabel
ChannelLabel(boolean channelIconsVisible, boolean textIsVisible)
          Creates the ChanelLabel
ChannelLabel(boolean channelIconsVisible, boolean textIsVisible, boolean showDefaultValues)
          Creates the ChanelLabel
ChannelLabel(boolean channelIconsVisible, boolean textIsVisible, boolean showDefaultValues, boolean showCountry)
          Creates the ChanelLabel
ChannelLabel(boolean channelIconsVisible, boolean textIsVisible, boolean showDefaultValues, boolean showCountry, boolean showJoinedChannelInfo)
          Creates the ChanelLabel
ChannelLabel(boolean channelIconsVisible, boolean textIsVisible, boolean showDefaultValues, boolean showCountry, boolean showJoinedChannelInfo, boolean showTimeLimitation)
          Creates the ChanelLabel
ChannelLabel(Channel channel)
          Creates the ChannelLabel
ChannelLabel(Channel channel, boolean channelIconsVisible)
          Creates the ChannelLabel
ChannelLabel(Channel channel, boolean channelIconsVisible, boolean textIsVisible)
          Creates the ChannelLabel
 
Method Summary
static void clearIconCache()
          Clear the icon cache.
 Channel getChannel()
           
 void setChannel(Channel channel)
          Sets the Channel to display
 void setIcon(javax.swing.Icon ic)
          do not call this method, use setChannel instead, which will set an icon matching all the current settings for the selected channel
 void setMinimumSize(java.awt.Dimension dim)
          Set the minimum-Size.
 void setShowCountry(boolean showCountry)
          Should the country be added to the channel name ?
 void setShowService(boolean showService)
          Should the service name be added to the channel name ?
 void setShowTimeLimitation(boolean showTimeLimitation)
          Should the time limitation info shown in label.
 
Methods inherited from class javax.swing.JLabel
checkHorizontalKey, checkVerticalKey, getAccessibleContext, getDisabledIcon, getDisplayedMnemonic, getDisplayedMnemonicIndex, getHorizontalAlignment, getHorizontalTextPosition, getIcon, getIconTextGap, getLabelFor, getText, getUI, getUIClassID, getVerticalAlignment, getVerticalTextPosition, imageUpdate, paramString, setDisabledIcon, setDisplayedMnemonic, setDisplayedMnemonic, setDisplayedMnemonicIndex, setHorizontalAlignment, setHorizontalTextPosition, setIconTextGap, setLabelFor, setText, setUI, setVerticalAlignment, setVerticalTextPosition, updateUI
 
Methods inherited from class javax.swing.JComponent
addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, 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, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, 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, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update
 
Methods inherited from class java.awt.Container
add, add, 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, 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

DEFAULT_ICON

static javax.swing.Icon DEFAULT_ICON
default channel icon, already prepared for right size

Constructor Detail

ChannelLabel

public ChannelLabel()
Creates the ChannelLabel


ChannelLabel

public ChannelLabel(boolean channelIconsVisible)
Creates the ChannelLabel

Parameters:
channelIconsVisible - Should the Icon be visible

ChannelLabel

public ChannelLabel(boolean channelIconsVisible,
                    boolean textIsVisible)
Creates the ChanelLabel

Parameters:
channelIconsVisible - Should the Icon be visible
textIsVisible - Should Text be visible ?

ChannelLabel

public ChannelLabel(boolean channelIconsVisible,
                    boolean textIsVisible,
                    boolean showDefaultValues)
Creates the ChanelLabel

Parameters:
channelIconsVisible - Should the Icon be visible
textIsVisible - Should Text be visible ?
showDefaultValues - Show the default channel icon and name.

ChannelLabel

public ChannelLabel(boolean channelIconsVisible,
                    boolean textIsVisible,
                    boolean showDefaultValues,
                    boolean showCountry)
Creates the ChanelLabel

Parameters:
channelIconsVisible - Should the Icon be visible
textIsVisible - Should Text be visible ?
showDefaultValues - Show the default channel icon and name.
showCountry - Show information about the country
Since:
2.6

ChannelLabel

public ChannelLabel(boolean channelIconsVisible,
                    boolean textIsVisible,
                    boolean showDefaultValues,
                    boolean showCountry,
                    boolean showJoinedChannelInfo)
Creates the ChanelLabel

Parameters:
channelIconsVisible - Should the Icon be visible
textIsVisible - Should Text be visible ?
showDefaultValues - Show the default channel icon and name.
showCountry - Show information about the country
showJoinedChannelInfo - If the joined channel name and icon should be shown.
Since:
3.2.1

ChannelLabel

public ChannelLabel(boolean channelIconsVisible,
                    boolean textIsVisible,
                    boolean showDefaultValues,
                    boolean showCountry,
                    boolean showJoinedChannelInfo,
                    boolean showTimeLimitation)
Creates the ChanelLabel

Parameters:
channelIconsVisible - Should the Icon be visible
textIsVisible - Should Text be visible ?
showDefaultValues - Show the default channel icon and name.
showCountry - Show information about the country
showJoinedChannelInfo - If the joined channel name and icon should be shown.
showTimeLimitation - If the time limitations should be shown.
Since:
3.2.1

ChannelLabel

public ChannelLabel(Channel channel)
Creates the ChannelLabel

Parameters:
channel - Channel to display

ChannelLabel

public ChannelLabel(Channel channel,
                    boolean channelIconsVisible,
                    boolean textIsVisible)
Creates the ChannelLabel

Parameters:
channel - Channel to display
channelIconsVisible - Should the Icon be visible
textIsVisible - Should Text be visible ?
Since:
2.2

ChannelLabel

public ChannelLabel(Channel channel,
                    boolean channelIconsVisible)
Creates the ChannelLabel

Parameters:
channel - Channel to display
channelIconsVisible - Should the Icon be visible
Since:
2.2
Method Detail

setChannel

public void setChannel(Channel channel)
Sets the Channel to display

Parameters:
channel - Channel to display

setMinimumSize

public void setMinimumSize(java.awt.Dimension dim)
Set the minimum-Size. Overridden to set the Size now

Overrides:
setMinimumSize in class javax.swing.JComponent
Parameters:
dim -

setIcon

public void setIcon(javax.swing.Icon ic)
do not call this method, use setChannel instead, which will set an icon matching all the current settings for the selected channel

Overrides:
setIcon in class javax.swing.JLabel
Parameters:
ic - Icon

setShowCountry

public void setShowCountry(boolean showCountry)
Should the country be added to the channel name ?

Parameters:
showCountry - add country name to channel name ?
Since:
2.6

setShowService

public void setShowService(boolean showService)
Should the service name be added to the channel name ?

Parameters:
showService - add service name to channel name ?
Since:
2.6

setShowTimeLimitation

public void setShowTimeLimitation(boolean showTimeLimitation)
Should the time limitation info shown in label.

Parameters:
showTimeLimitation - If the time limitation should be shown.
Since:
3.2.1

clearIconCache

public static void clearIconCache()
Clear the icon cache.
This may be useful after lots of channel labels have been created (e.g. in the settings dialog).

Since:
2.7

getChannel

public Channel getChannel()
Returns:
The current Channel
Since:
3.0

TV-Browser 3.3.3 API

TV-Browser 3.3.3, Copyright (C) 2004-2008 TV-Browser Team (dev@tvbrowser.org)