oracle.jdeveloper.model

Class ContentSetPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

oracle.jdeveloper.model.ContentSetPanel

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class ContentSetPanel
extends javax.swing.JPanel

Panel for displaying and editing ContentSets.

See Also:

ContentSet, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ContentSetPanel.EmptyContentSetException Signals that the ContentSet is empty, that is, there is no content folder specified.

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

javax.swing.JPanel.AccessibleJPanel

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

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

Constructors

Constructor and Description
ContentSetPanel() Creates a ContentSetPanel with no ContentSetValidator.
ContentSetPanel(ContentSetValidator validator) Constructs a new ContentSetPanel with the supplied validator.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addFolderToContentSet(java.net.URL contentFolderURL) Adds the supplied URL as a content folder.
boolean	addFolderToContentSet(java.net.URL contentFolderURL, java.net.URL srcRootURL) Adds the supplied URL as a content folder.
boolean	contentSetContainsURL(java.net.URL url) Indicates whether or not the supplied URL is already in the ConentSet.
URLPath	getURLPath() Returns a copy of the path given by the list of urls displayed in this panel.
ContentSetValidator	getValidator() Gets the validator associated with this panel.
void	hideUpDownButtons() Hides the up and down buttons so that the panel can fit into a smaller space.
void	loadFrom(Project project, ContentSet contentSet) Initializes the panel from the supplied Project and ContentSet.
void	saveContentSet() Persists the changes reflected in the list to the active ContentSet.
void	setContentSetLabel(java.lang.String label) Sets the label for the list of project contents.
void	setValidator(ContentSetValidator validator) Sets the ContentSetValidator used to validate and process the content folders the user wants to add the the ContentSet.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, 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, isPaintingOrigin, 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, setMinimumSize, 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, 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, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentSetPanel

public ContentSetPanel()

Creates a ContentSetPanel with no ContentSetValidator. To supply a validator, call setValidator.

See Also:

setValidator(ContentSetValidator)

ContentSetPanel

public ContentSetPanel(ContentSetValidator validator)

Constructs a new ContentSetPanel with the supplied validator.

Parameters:

validator - the ContentSetValidator

Method Detail

setContentSetLabel

public void setContentSetLabel(java.lang.String label)

Sets the label for the list of project contents.

Parameters:

label - the new label

setValidator

public void setValidator(ContentSetValidator validator)

Sets the ContentSetValidator used to validate and process the content folders the user wants to add the the ContentSet.

Parameters:

validator - a ContentSetValidator

getValidator

public ContentSetValidator getValidator()

Gets the validator associated with this panel.

Returns:

a ContentSetValidator or null if none was supplied.

loadFrom

public void loadFrom(Project project,
            ContentSet contentSet)

Initializes the panel from the supplied Project and ContentSet.

Parameters:

project - the active project

contentSet - the ContentSet to display/edit.

saveContentSet

public void saveContentSet()
                    throws ContentSetPanel.EmptyContentSetException

Persists the changes reflected in the list to the active ContentSet.

Throws:

ContentSetPanel.EmptyContentSetException

hideUpDownButtons

public void hideUpDownButtons()

Hides the up and down buttons so that the panel can fit into a smaller space. This is generally discouraged; the up and down buttons do serve a purpose.

addFolderToContentSet

public boolean addFolderToContentSet(java.net.URL contentFolderURL)

Adds the supplied URL as a content folder. As a result, of calling this method the contentFolderURL is added to the ContentSet's URL path and a filter is created that includes the entire contents of this folder.

If contentFolderURL already exists in the ContentSet, this the URL is not added and the method returns false. Otherwise, if the supplied URL is unique to the ContentSet, it is added and the method returns true.

Parameters:

contentFolderURL - the URL for the content folder

Returns:

true if the URL was added, false if the content folder already exists in the ContentSet.

addFolderToContentSet

public boolean addFolderToContentSet(java.net.URL contentFolderURL,
                            java.net.URL srcRootURL)

Adds the supplied URL as a content folder. As a result, of calling this method the contentFolderURL is added to the ContentSet's URL path and a filter is created that includes the entire contents of this folder.

If contentFolderURL already exists in the ContentSet, this the URL is not added and the method returns false. Otherwise, if the supplied URL is unique to the ContentSet, it is added and the method returns true.

Parameters:

contentFolderURL - the URL for the content folder

srcRootURL - the URL for the source root

Returns:

true if the URL was added, false if the content folder already exists in the ContentSet.

getURLPath

public URLPath getURLPath()

Returns a copy of the path given by the list of urls displayed in this panel.

Returns:

displayed path, will not be null

contentSetContainsURL

public boolean contentSetContainsURL(java.net.URL url)

Indicates whether or not the supplied URL is already in the ConentSet.

Parameters:

url - the URL

Returns:

true if the URL is already in the ContentSet, false otherwise.