public abstract class AbstractPropertyEditorPanel
extends javax.swing.JPanel
implements javax.swing.Scrollable
DesignerContext.addPropertyEditor(Class)
for a more detailed
description. Subclasses must have either a nullary (no-arg) constructor, or one that takes a DesignerContext
Modifier and Type | Class and Description |
---|---|
protected class |
AbstractPropertyEditorPanel.ComponentChangeListener |
javax.swing.JPanel.AccessibleJPanel
javax.swing.JComponent.AccessibleJComponent
Modifier and Type | Field and Description |
---|---|
protected boolean |
changed |
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
Modifier | Constructor and Description |
---|---|
protected |
AbstractPropertyEditorPanel() |
protected |
AbstractPropertyEditorPanel(java.awt.LayoutManager layout) |
Modifier and Type | Method and Description |
---|---|
abstract java.lang.Object |
commit()
Create the object to be serialized and stored in the page's corresponding project resource
|
boolean |
dryCommit()
Test the input of the page for validity before commit.
|
abstract java.lang.String |
getCategory()
Returns a dot-separated category placement.
|
javax.swing.Icon |
getIcon() |
protected AbstractPropertyEditorPanel.ComponentChangeListener |
getListener()
Returns a shared instanceof (for this panel) of a ComponentChangeListener
|
abstract java.lang.String |
getModuleId()
The module id key used to look up this page's project resource
|
java.awt.Dimension |
getPreferredScrollableViewportSize() |
int |
getResourceScope()
The application scope for the ProjectResource that represents this property category
|
abstract java.lang.String |
getResourceType()
The resource type key used to look up this page's project resource
|
int |
getScrollableBlockIncrement(java.awt.Rectangle visibleRect,
int orientation,
int direction) |
boolean |
getScrollableTracksViewportHeight() |
boolean |
getScrollableTracksViewportWidth() |
int |
getScrollableUnitIncrement(java.awt.Rectangle visibleRect,
int orientation,
int direction) |
abstract java.lang.String |
getTitleKey()
Resource key for the banner on top of the editor panel
|
abstract void |
initProps(java.lang.Object props)
Initialize the page with the given properties.
|
protected int |
intValueOf(javax.swing.JSpinner spinner) |
boolean |
isChanged()
Have any of the properties represented by this page changed?
|
protected void |
listenTo(javax.swing.AbstractButton... buttons)
Adds a listener to the component(s) that will set the changed boolean when the value changes
|
protected void |
listenTo(AbstractProfileOptionDropdown... boxes)
Adds a listener to the component(s) that will set the changed boolean when the value changes
|
protected void |
listenTo(javax.swing.JComboBox... boxes)
Adds a listener to the component(s) that will set the changed boolean when the value changes
|
protected void |
listenTo(javax.swing.JSlider... sliders)
Adds a listener to the component(s) that will set the changed boolean when the value changes
|
protected void |
listenTo(javax.swing.JSpinner... spinners)
Adds a listener to the component(s) that will set the changed boolean when the value changes
|
protected void |
listenTo(javax.swing.text.JTextComponent... fields)
Adds a listener to the component(s) that will set the changed boolean when the value changes
|
void |
setChanged(boolean b) |
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
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, hide, 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
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
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, 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
protected AbstractPropertyEditorPanel()
protected AbstractPropertyEditorPanel(java.awt.LayoutManager layout)
public void setChanged(boolean b)
protected AbstractPropertyEditorPanel.ComponentChangeListener getListener()
protected void listenTo(javax.swing.JComboBox... boxes)
protected void listenTo(AbstractProfileOptionDropdown... boxes)
protected void listenTo(javax.swing.AbstractButton... buttons)
protected void listenTo(javax.swing.text.JTextComponent... fields)
protected void listenTo(javax.swing.JSpinner... spinners)
protected void listenTo(javax.swing.JSlider... sliders)
public abstract java.lang.String getCategory()
public abstract java.lang.String getTitleKey()
public javax.swing.Icon getIcon()
public abstract void initProps(java.lang.Object props)
props
- Deserialized object from this page's corresponding ProjectResource, or null if the resource
didn't exist.public boolean isChanged()
public boolean dryCommit()
public abstract java.lang.Object commit()
public abstract java.lang.String getModuleId()
public abstract java.lang.String getResourceType()
public int getResourceScope()
protected int intValueOf(javax.swing.JSpinner spinner)
public java.awt.Dimension getPreferredScrollableViewportSize()
getPreferredScrollableViewportSize
in interface javax.swing.Scrollable
public int getScrollableUnitIncrement(java.awt.Rectangle visibleRect, int orientation, int direction)
getScrollableUnitIncrement
in interface javax.swing.Scrollable
public int getScrollableBlockIncrement(java.awt.Rectangle visibleRect, int orientation, int direction)
getScrollableBlockIncrement
in interface javax.swing.Scrollable
public boolean getScrollableTracksViewportWidth()
getScrollableTracksViewportWidth
in interface javax.swing.Scrollable
public boolean getScrollableTracksViewportHeight()
getScrollableTracksViewportHeight
in interface javax.swing.Scrollable