Modifier and Type	Class and Description
protected class	ProgressMonitor.AccessibleProgressMonitor `AccessibleProgressMonitor` implements accessibility support for the `ProgressMonitor` class.
private class	ProgressMonitor.ProgressOptionPane

Modifier and Type	Field and Description
protected AccessibleContext	accessibleContext The `AccessibleContext` for the `ProgressMonitor`
private AccessibleContext	accessibleJOptionPane
private Object[]	cancelOption
private JDialog	dialog
private int	max
private Object	message
private int	millisToDecideToPopup
private int	millisToPopup
private int	min
private JProgressBar	myBar
private String	note
private JLabel	noteLabel
private JOptionPane	pane
private Component	parentComponent
private ProgressMonitor	root
private long	T0

Access	Constructor and Description
public	ProgressMonitor(Component the parent component for the dialog box parentComponent, Object a descriptive message that will be shown to the user to indicate what operation is being monitored. This does not change as the operation progresses. See the message parameters to methods in `JOptionPane#message` for the range of values. message, String a short note describing the state of the operation. As the operation progresses, you can call setNote to change the note displayed. This is used, for example, in operations that iterate through a list of files to show the name of the file being processes. If note is initially null, there will be no note line in the dialog box and setNote will be ineffective note, int the lower bound of the range min, int the upper bound of the range max) Constructs a graphic object that shows progress, typically by filling in a rectangular bar as the process nears completion.
private	ProgressMonitor(Component parentComponent, Object message, String note, int min, int max, ProgressMonitor group)

Modifier and Type	Method and Description
public void	close() Indicate that the operation is complete.
public AccessibleContext	Returns: the `AccessibleContext` for the `ProgressMonitor` getAccessibleContext() Implements javax.accessibility.Accessible.getAccessibleContext. Gets the `AccessibleContext` for the `ProgressMonitor`
public int	Returns: an int representing the maximum value getMaximum() Returns the maximum value -- the higher end of the progress value.
public int	Returns: the amount of time in milliseconds this object waits before deciding whether or not to popup a progress monitor getMillisToDecideToPopup() Returns the amount of time this object waits before deciding whether or not to popup a progress monitor.
public int	Returns: the amount of time in milliseconds it will take for the popup to appear getMillisToPopup() Returns the amount of time it will take for the popup to appear.
public int	Returns: an int representing the minimum value getMinimum() Returns the minimum value -- the lower end of the progress value.
public String	Returns: a String specifying the note to display getNote() Specifies the additional note that is displayed along with the progress message.
public boolean	Returns: true if the user hits the Cancel button or closes the progress dialog isCanceled() Returns true if the user hits the Cancel button or closes the progress dialog.
public void	setMaximum(int an int specifying the maximum value m) Specifies the maximum value.
public void	setMillisToDecideToPopup(int an int specifying the time to wait, in milliseconds millisToDecideToPopup) Specifies the amount of time to wait before deciding whether or not to popup a progress monitor.
public void	setMillisToPopup(int an int specifying the time in milliseconds millisToPopup) Specifies the amount of time it will take for the popup to appear.
public void	setMinimum(int an int specifying the minimum value m) Specifies the minimum value.
public void	setNote(String a String specifying the note to display note) Specifies the additional note that is displayed along with the progress message.
public void	setProgress(int an int specifying the current value, between the maximum and minimum specified for this component nv) Indicate the progress of the operation being monitored.

accessibleContext	back to summary
protected AccessibleContext accessibleContext The `AccessibleContext` for the `ProgressMonitor` Since 1.5

accessibleJOptionPane	back to summary
private AccessibleContext accessibleJOptionPane

cancelOption	back to summary
private Object[] cancelOption

dialog	back to summary
private JDialog dialog

max	back to summary
private int max

message	back to summary
private Object message

millisToDecideToPopup	back to summary
private int millisToDecideToPopup

millisToPopup	back to summary
private int millisToPopup

min	back to summary
private int min

myBar	back to summary
private JProgressBar myBar

note	back to summary
private String note

noteLabel	back to summary
private JLabel noteLabel

pane	back to summary
private JOptionPane pane

parentComponent	back to summary
private Component parentComponent

root	back to summary
private ProgressMonitor root

T0	back to summary
private long T0

ProgressMonitor	back to summary
public ProgressMonitor(Component parentComponent, Object message, String note, int min, int max) Constructs a graphic object that shows progress, typically by filling in a rectangular bar as the process nears completion. Parameters parentComponent:Component the parent component for the dialog box message:Object a descriptive message that will be shown to the user to indicate what operation is being monitored. This does not change as the operation progresses. See the message parameters to methods in `JOptionPane#message` for the range of values. note:String a short note describing the state of the operation. As the operation progresses, you can call setNote to change the note displayed. This is used, for example, in operations that iterate through a list of files to show the name of the file being processes. If note is initially null, there will be no note line in the dialog box and setNote will be ineffective min:int the lower bound of the range max:int the upper bound of the range See Also `JDialog`, `JOptionPane`

ProgressMonitor	back to summary
private ProgressMonitor(Component parentComponent, Object message, String note, int min, int max, ProgressMonitor group)

Method Detail

close	back to summary
public void close() Indicate that the operation is complete. This happens automatically when the value set by setProgress is >= max, but it may be called earlier if the operation ends early.

getAccessibleContext back to summary

getAccessibleContext	back to summary
public AccessibleContext getAccessibleContext() Implements javax.accessibility.Accessible.getAccessibleContext. Gets the `AccessibleContext` for the `ProgressMonitor` Returns:AccessibleContext the `AccessibleContext` for the `ProgressMonitor` Since 1.5

public AccessibleContext getAccessibleContext()

Implements javax.accessibility.Accessible.getAccessibleContext.

Gets the AccessibleContext for the ProgressMonitor

Returns:AccessibleContext: the AccessibleContext for the ProgressMonitor
Since: 1.5

getMaximum back to summary

getMaximum	back to summary
public int getMaximum() Returns the maximum value -- the higher end of the progress value. Returns:int an int representing the maximum value See Also `setMaximum`

public int getMaximum()

Returns the maximum value -- the higher end of the progress value.

Returns:int: an int representing the maximum value
See Also: setMaximum

getMillisToDecideToPopup back to summary

getMillisToDecideToPopup	back to summary
public int getMillisToDecideToPopup() Returns the amount of time this object waits before deciding whether or not to popup a progress monitor. Returns:int the amount of time in milliseconds this object waits before deciding whether or not to popup a progress monitor See Also `setMillisToDecideToPopup`

public int getMillisToDecideToPopup()

Returns the amount of time this object waits before deciding whether or not to popup a progress monitor.

Returns:int: the amount of time in milliseconds this object waits before deciding whether or not to popup a progress monitor
See Also: setMillisToDecideToPopup

getMillisToPopup back to summary

getMillisToPopup	back to summary
public int getMillisToPopup() Returns the amount of time it will take for the popup to appear. Returns:int the amount of time in milliseconds it will take for the popup to appear See Also `setMillisToPopup`

public int getMillisToPopup()

Returns the amount of time it will take for the popup to appear.

Returns:int: the amount of time in milliseconds it will take for the popup to appear
See Also: setMillisToPopup

getMinimum back to summary

getMinimum	back to summary
public int getMinimum() Returns the minimum value -- the lower end of the progress value. Returns:int an int representing the minimum value See Also `setMinimum`

public int getMinimum()

Returns the minimum value -- the lower end of the progress value.

Returns:int: an int representing the minimum value
See Also: setMinimum

getNote back to summary

getNote	back to summary
public String getNote() Specifies the additional note that is displayed along with the progress message. Returns:String a String specifying the note to display See Also `setNote`

public String getNote()

Specifies the additional note that is displayed along with the progress message.

Returns:String: a String specifying the note to display
See Also: setNote

isCanceled	back to summary
public boolean isCanceled() Returns true if the user hits the Cancel button or closes the progress dialog. Returns:boolean true if the user hits the Cancel button or closes the progress dialog

isCanceled

back to summary

public boolean isCanceled()

Returns true if the user hits the Cancel button or closes the progress dialog.

Returns:boolean: true if the user hits the Cancel button or closes the progress dialog

setMaximum back to summary

setMaximum	back to summary
public void setMaximum(int m) Specifies the maximum value. Parameters m:int an int specifying the maximum value See Also `getMaximum`

public void setMaximum(int m)

Specifies the maximum value.

Parameters

m:int: an int specifying the maximum value

See Also

getMaximum

setMillisToDecideToPopup back to summary

setMillisToDecideToPopup	back to summary
public void setMillisToDecideToPopup(int millisToDecideToPopup) Specifies the amount of time to wait before deciding whether or not to popup a progress monitor. Parameters millisToDecideToPopup:int an int specifying the time to wait, in milliseconds See Also `getMillisToDecideToPopup`

public void setMillisToDecideToPopup(int millisToDecideToPopup)

Specifies the amount of time to wait before deciding whether or not to popup a progress monitor.

Parameters

millisToDecideToPopup:int: an int specifying the time to wait, in milliseconds

See Also

getMillisToDecideToPopup

setMillisToPopup back to summary

setMillisToPopup	back to summary
public void setMillisToPopup(int millisToPopup) Specifies the amount of time it will take for the popup to appear. (If the predicted time remaining is less than this time, the popup won't be displayed.) Parameters millisToPopup:int an int specifying the time in milliseconds See Also `getMillisToPopup`

public void setMillisToPopup(int millisToPopup)

Specifies the amount of time it will take for the popup to appear. (If the predicted time remaining is less than this time, the popup won't be displayed.)

Parameters

millisToPopup:int: an int specifying the time in milliseconds

See Also

getMillisToPopup

setMinimum back to summary

setMinimum	back to summary
public void setMinimum(int m) Specifies the minimum value. Parameters m:int an int specifying the minimum value See Also `getMinimum`

public void setMinimum(int m)

Specifies the minimum value.

Parameters

m:int: an int specifying the minimum value

See Also

getMinimum

setNote back to summary

setNote	back to summary
public void setNote(String note) Specifies the additional note that is displayed along with the progress message. Used, for example, to show which file the is currently being copied during a multiple-file copy. Parameters note:String a String specifying the note to display See Also `getNote`

public void setNote(String note)

Specifies the additional note that is displayed along with the progress message. Used, for example, to show which file the is currently being copied during a multiple-file copy.

Parameters

note:String: a String specifying the note to display

See Also

getNote

setProgress back to summary

setProgress	back to summary
public void setProgress(int nv) Indicate the progress of the operation being monitored. If the specified value is >= the maximum, the progress monitor is closed. Parameters nv:int an int specifying the current value, between the maximum and minimum specified for this component Annotations @SuppressWarnings:deprecation See Also `setMinimum`, `setMaximum`, `close`

public void setProgress(int nv)

Indicate the progress of the operation being monitored. If the specified value is >= the maximum, the progress monitor is closed.

Parameters

nv:int: an int specifying the current value, between the maximum and minimum specified for this component

Annotations

@SuppressWarnings:deprecation

See Also

setMinimum, setMaximum, close

javax.swing back to summary

protected Class ProgressMonitor.AccessibleProgressMonitor

Class Inheritance

extends AccessibleContext
implements AccessibleText, ChangeListener, PropertyChangeListener

java.lang.Object
javax.accessibility.AccessibleContext
javax.swing.ProgressMonitor.AccessibleProgressMonitor

All Implemented Interfaces

java.beans.PropertyChangeListener, java.util.EventListener, javax.swing.event.ChangeListener, javax.accessibility.AccessibleText

AccessibleProgressMonitor implements accessibility support for the ProgressMonitor class.

Since: 1.5

Field Summary

Modifier and Type	Field and Description
private Object	oldModelValue

Constructor Summary

Access	Constructor and Description
protected	AccessibleProgressMonitor() AccessibleProgressMonitor constructor

Method Summary

Modifier and Type	Method and Description
public Accessible	Returns: the Accessible child of the object getAccessibleChild(int zero-based index of child i) Implements abstract javax.accessibility.AccessibleContext.getAccessibleChild. Returns the specified Accessible child of the object.
public int	Returns: the number of accessible children of the object. getAccessibleChildrenCount() Implements abstract javax.accessibility.AccessibleContext.getAccessibleChildrenCount. Returns the number of accessible children of the object.
public AccessibleComponent	Returns: AccessibleComponent if supported by object; else return null getAccessibleComponent() Overrides javax.accessibility.AccessibleContext.getAccessibleComponent. Gets the AccessibleComponent associated with this object that has a graphical representation.
public String	Returns: the localized description of the object; null if this object does not have a description getAccessibleDescription() Overrides javax.accessibility.AccessibleContext.getAccessibleDescription. Gets the accessibleDescription property of this object.
public int	Returns: the 0-based index of this object in its parent; -1 if this object does not have an accessible parent. getAccessibleIndexInParent() Implements abstract javax.accessibility.AccessibleContext.getAccessibleIndexInParent. Gets the 0-based index of this object in its accessible parent.
public String	Returns: the localized name of the object; null if this object does not have a name getAccessibleName() Overrides javax.accessibility.AccessibleContext.getAccessibleName. Gets the accessibleName property of this object.
public Accessible	Returns: the Accessible parent of this object; null if this object does not have an Accessible parent getAccessibleParent() Overrides javax.accessibility.AccessibleContext.getAccessibleParent. Gets the Accessible parent of this object.
public AccessibleRole	Returns: an instance of AccessibleRole describing the role of the object getAccessibleRole() Implements abstract javax.accessibility.AccessibleContext.getAccessibleRole. Gets the role of this object.
public AccessibleStateSet	Returns: an instance of AccessibleStateSet containing the current state set of the object getAccessibleStateSet() Implements abstract javax.accessibility.AccessibleContext.getAccessibleStateSet. Gets the state set of this object.
public AccessibleText	Returns: AccessibleText if supported by object; else return null getAccessibleText() Overrides javax.accessibility.AccessibleContext.getAccessibleText. Gets the AccessibleText associated with this object presenting text on the display.
public AccessibleValue	Returns: AccessibleValue if supported by object; else return null getAccessibleValue() Overrides javax.accessibility.AccessibleContext.getAccessibleValue. Gets the AccessibleValue associated with this object that supports a Numerical value.
public String	Returns: the letter, word, or sentence getAfterIndex(int the CHARACTER, WORD, or SENTENCE to retrieve part, int an index within the text index) Implements javax.accessibility.AccessibleText.getAfterIndex. Returns the String after a given index.
public String	Returns: the letter, word, or sentence getAtIndex(int the CHARACTER, WORD, or SENTENCE to retrieve part, int an index within the text index) Implements javax.accessibility.AccessibleText.getAtIndex. Returns the String at a given index.
public String	Returns: the letter, word, or sentence getBeforeIndex(int the CHARACTER, WORD, or SENTENCE to retrieve part, int an index within the text index) Implements javax.accessibility.AccessibleText.getBeforeIndex. Returns the String before a given index.
public int	Returns: the zero-based offset of the caret. getCaretPosition() Implements javax.accessibility.AccessibleText.getCaretPosition. Returns the zero-based offset of the caret.
public AttributeSet	Returns: the AttributeSet of the character getCharacterAttribute(int the zero-based index into the text i) Implements javax.accessibility.AccessibleText.getCharacterAttribute. Returns the AttributeSet for a given character at a given index
public Rectangle	Returns: the screen coordinates of the character's bounding box, if index is invalid return an empty rectangle. getCharacterBounds(int the index into the String i) Implements javax.accessibility.AccessibleText.getCharacterBounds. Determines the bounding box of the character at the given index into the string.
public int	Returns: the number of characters getCharCount() Implements javax.accessibility.AccessibleText.getCharCount. Returns the number of characters (valid indices)
public int	Returns: the zero-based index of the character under Point p; if Point is invalid return -1. getIndexAtPoint(Point the Point in local coordinates p) Implements javax.accessibility.AccessibleText.getIndexAtPoint. Given a point in local coordinates, return the zero-based index of the character under that Point.
public Locale	Returns: this component's locale. If this component does not have a locale, the locale of its parent is returned. getLocale() Implements abstract javax.accessibility.AccessibleContext.getLocale. Gets the locale of the component.
private AccessibleText	getNoteLabelAccessibleText()
private AccessibleContext	getPanelAccessibleContext()
private AccessibleContext	getParentAccessibleContext()
public String	Returns: the String portion of the text that is selected getSelectedText() Implements javax.accessibility.AccessibleText.getSelectedText. Returns the portion of the text that is selected.
public int	Returns: the index into the text of the end of the selection getSelectionEnd() Implements javax.accessibility.AccessibleText.getSelectionEnd. Returns the end offset within the selected text.
public int	Returns: the index into the text of the start of the selection getSelectionStart() Implements javax.accessibility.AccessibleText.getSelectionStart. Returns the start offset within the selected text.
private void	optionPaneCreated()
public void	propertyChange(PropertyChangeEvent A `PropertyChangeEvent` object describing the event source and the property that has changed. Must not be null. e) Implements java.beans.PropertyChangeListener.propertyChange. This method gets called when a bound property is changed.
private boolean	sameWindowAncestor(Component src, Component dest)
public void	stateChanged(ChangeEvent a `ChangeEvent` object. Must not be null. e) Implements javax.swing.event.ChangeListener.stateChanged. Invoked when the target of the listener has changed its state.

Inherited from javax.accessibility.AccessibleContext:: addPropertyChangeListener firePropertyChange getAccessibleAction getAccessibleEditableText getAccessibleIcon getAccessibleRelationSet getAccessibleSelection getAccessibleTable removePropertyChangeListener setAccessibleDescription setAccessibleName setAccessibleParent

Field Detail

oldModelValue	back to summary
private Object oldModelValue

Constructor Detail

AccessibleProgressMonitor	back to summary
protected AccessibleProgressMonitor() AccessibleProgressMonitor constructor

Method Detail

getAccessibleChild back to summary

getAccessibleChild	back to summary
public Accessible getAccessibleChild(int i) Implements abstract javax.accessibility.AccessibleContext.getAccessibleChild. Returns the specified Accessible child of the object. The Accessible children of an Accessible object are zero-based, so the first child of an Accessible child is at index 0, the second child is at index 1, and so on. Parameters i:int zero-based index of child Returns:Accessible the Accessible child of the object See Also `getAccessibleChildrenCount`

public Accessible getAccessibleChild(int i)

Implements abstract javax.accessibility.AccessibleContext.getAccessibleChild.

Returns the specified Accessible child of the object. The Accessible children of an Accessible object are zero-based, so the first child of an Accessible child is at index 0, the second child is at index 1, and so on.

Parameters

i:int: zero-based index of child

Returns:Accessible

the Accessible child of the object

See Also

getAccessibleChildrenCount

getAccessibleChildrenCount	back to summary
public int getAccessibleChildrenCount() Implements abstract javax.accessibility.AccessibleContext.getAccessibleChildrenCount. Returns the number of accessible children of the object. Returns:int the number of accessible children of the object.

getAccessibleChildrenCount

back to summary

public int getAccessibleChildrenCount()

Implements abstract javax.accessibility.AccessibleContext.getAccessibleChildrenCount.

Returns the number of accessible children of the object.

Returns:int: the number of accessible children of the object.

getAccessibleComponent back to summary

getAccessibleComponent	back to summary
public AccessibleComponent getAccessibleComponent() Overrides javax.accessibility.AccessibleContext.getAccessibleComponent. Gets the AccessibleComponent associated with this object that has a graphical representation. Returns:AccessibleComponent AccessibleComponent if supported by object; else return null See Also `AccessibleComponent`

public AccessibleComponent getAccessibleComponent()

Overrides javax.accessibility.AccessibleContext.getAccessibleComponent.

Gets the AccessibleComponent associated with this object that has a graphical representation.

Returns:AccessibleComponent: AccessibleComponent if supported by object; else return null
See Also: AccessibleComponent

getAccessibleDescription back to summary

getAccessibleDescription	back to summary
public String getAccessibleDescription() Overrides javax.accessibility.AccessibleContext.getAccessibleDescription. Gets the accessibleDescription property of this object. The accessibleDescription property of this object is a short localized phrase describing the purpose of the object. For example, in the case of a 'Cancel' button, the accessibleDescription could be 'Ignore changes and close dialog box.' Returns:String the localized description of the object; null if this object does not have a description See Also `setAccessibleDescription`

public String getAccessibleDescription()

Overrides javax.accessibility.AccessibleContext.getAccessibleDescription.

Gets the accessibleDescription property of this object. The accessibleDescription property of this object is a short localized phrase describing the purpose of the object. For example, in the case of a 'Cancel' button, the accessibleDescription could be 'Ignore changes and close dialog box.'

Returns:String: the localized description of the object; null if this object does not have a description
See Also: setAccessibleDescription

getAccessibleIndexInParent back to summary

getAccessibleIndexInParent	back to summary
public int getAccessibleIndexInParent() Implements abstract javax.accessibility.AccessibleContext.getAccessibleIndexInParent. Gets the 0-based index of this object in its accessible parent. Returns:int the 0-based index of this object in its parent; -1 if this object does not have an accessible parent. See Also `getAccessibleParent`, `getAccessibleChildrenCount`, `getAccessibleChild`

public int getAccessibleIndexInParent()

Implements abstract javax.accessibility.AccessibleContext.getAccessibleIndexInParent.

Gets the 0-based index of this object in its accessible parent.

Returns:int: the 0-based index of this object in its parent; -1 if this object does not have an accessible parent.
See Also: getAccessibleParent, getAccessibleChildrenCount, getAccessibleChild

getAccessibleName back to summary

getAccessibleName	back to summary
public String getAccessibleName() Overrides javax.accessibility.AccessibleContext.getAccessibleName. Gets the accessibleName property of this object. The accessibleName property of an object is a localized String that designates the purpose of the object. For example, the accessibleName property of a label or button might be the text of the label or button itself. In the case of an object that doesn't display its name, the accessibleName should still be set. For example, in the case of a text field used to enter the name of a city, the accessibleName for the en_US locale could be 'city.' Returns:String the localized name of the object; null if this object does not have a name See Also `setAccessibleName`

public String getAccessibleName()

Overrides javax.accessibility.AccessibleContext.getAccessibleName.

Gets the accessibleName property of this object. The accessibleName property of an object is a localized String that designates the purpose of the object. For example, the accessibleName property of a label or button might be the text of the label or button itself. In the case of an object that doesn't display its name, the accessibleName should still be set. For example, in the case of a text field used to enter the name of a city, the accessibleName for the en_US locale could be 'city.'

Returns:String: the localized name of the object; null if this object does not have a name
See Also: setAccessibleName

getAccessibleParent	back to summary
public Accessible getAccessibleParent() Overrides javax.accessibility.AccessibleContext.getAccessibleParent. Gets the Accessible parent of this object. Returns:Accessible the Accessible parent of this object; null if this object does not have an Accessible parent

getAccessibleParent

back to summary

public Accessible getAccessibleParent()

Overrides javax.accessibility.AccessibleContext.getAccessibleParent.

Gets the Accessible parent of this object.

Returns:Accessible: the Accessible parent of this object; null if this object does not have an Accessible parent

getAccessibleRole back to summary

getAccessibleRole	back to summary
public AccessibleRole getAccessibleRole() Implements abstract javax.accessibility.AccessibleContext.getAccessibleRole. Gets the role of this object. The role of the object is the generic purpose or use of the class of this object. For example, the role of a push button is AccessibleRole.PUSH_BUTTON. The roles in AccessibleRole are provided so component developers can pick from a set of predefined roles. This enables assistive technologies to provide a consistent interface to various tweaked subclasses of components (e.g., use AccessibleRole.PUSH_BUTTON for all components that act like a push button) as well as distinguish between subclasses that behave differently (e.g., AccessibleRole.CHECK_BOX for check boxes and AccessibleRole.RADIO_BUTTON for radio buttons). Note that the AccessibleRole class is also extensible, so custom component developers can define their own AccessibleRole's if the set of predefined roles is inadequate. Returns:AccessibleRole an instance of AccessibleRole describing the role of the object See Also `AccessibleRole`

public AccessibleRole getAccessibleRole()

Implements abstract javax.accessibility.AccessibleContext.getAccessibleRole.

Gets the role of this object. The role of the object is the generic purpose or use of the class of this object. For example, the role of a push button is AccessibleRole.PUSH_BUTTON. The roles in AccessibleRole are provided so component developers can pick from a set of predefined roles. This enables assistive technologies to provide a consistent interface to various tweaked subclasses of components (e.g., use AccessibleRole.PUSH_BUTTON for all components that act like a push button) as well as distinguish between subclasses that behave differently (e.g., AccessibleRole.CHECK_BOX for check boxes and AccessibleRole.RADIO_BUTTON for radio buttons).

Note that the AccessibleRole class is also extensible, so custom component developers can define their own AccessibleRole's if the set of predefined roles is inadequate.

Returns:AccessibleRole: an instance of AccessibleRole describing the role of the object
See Also: AccessibleRole

getAccessibleStateSet back to summary

getAccessibleStateSet	back to summary
public AccessibleStateSet getAccessibleStateSet() Implements abstract javax.accessibility.AccessibleContext.getAccessibleStateSet. Gets the state set of this object. The AccessibleStateSet of an object is composed of a set of unique AccessibleStates. A change in the AccessibleStateSet of an object will cause a PropertyChangeEvent to be fired for the ACCESSIBLE_STATE_PROPERTY property. Returns:AccessibleStateSet an instance of AccessibleStateSet containing the current state set of the object See Also `AccessibleStateSet`, `AccessibleState`, `addPropertyChangeListener`

public AccessibleStateSet getAccessibleStateSet()

Implements abstract javax.accessibility.AccessibleContext.getAccessibleStateSet.

Gets the state set of this object. The AccessibleStateSet of an object is composed of a set of unique AccessibleStates. A change in the AccessibleStateSet of an object will cause a PropertyChangeEvent to be fired for the ACCESSIBLE_STATE_PROPERTY property.

Returns:AccessibleStateSet: an instance of AccessibleStateSet containing the current state set of the object
See Also: AccessibleStateSet, AccessibleState, addPropertyChangeListener

getAccessibleText back to summary

public AccessibleText getAccessibleText()

Overrides javax.accessibility.AccessibleContext.getAccessibleText.

Gets the AccessibleText associated with this object presenting text on the display.

Returns:AccessibleText: AccessibleText if supported by object; else return null
See Also: AccessibleText

getAccessibleValue back to summary

public AccessibleValue getAccessibleValue()

Overrides javax.accessibility.AccessibleContext.getAccessibleValue.

Gets the AccessibleValue associated with this object that supports a Numerical value.

Returns:AccessibleValue: AccessibleValue if supported by object; else return null
See Also: AccessibleValue

getAfterIndex

back to summary

public String getAfterIndex(int part, int index)

Implements javax.accessibility.AccessibleText.getAfterIndex.

Returns the String after a given index.

Parameters

part:int: the CHARACTER, WORD, or SENTENCE to retrieve
index:int: an index within the text

Returns:String

the letter, word, or sentence

getAtIndex

back to summary

public String getAtIndex(int part, int index)

Implements javax.accessibility.AccessibleText.getAtIndex.

Returns the String at a given index.

Parameters

part:int: the CHARACTER, WORD, or SENTENCE to retrieve
index:int: an index within the text

Returns:String

the letter, word, or sentence

getBeforeIndex

back to summary

public String getBeforeIndex(int part, int index)

Implements javax.accessibility.AccessibleText.getBeforeIndex.

Returns the String before a given index.

Parameters

part:int: the CHARACTER, WORD, or SENTENCE to retrieve
index:int: an index within the text

Returns:String

the letter, word, or sentence

getCaretPosition

back to summary

public int getCaretPosition()

Implements javax.accessibility.AccessibleText.getCaretPosition.

Returns the zero-based offset of the caret.

Note

That to the right of the caret will have the same index value as the offset (the caret is between two characters).

Returns:int: the zero-based offset of the caret.

getCharacterAttribute

back to summary

public AttributeSet getCharacterAttribute(int i)

Implements javax.accessibility.AccessibleText.getCharacterAttribute.

Returns the AttributeSet for a given character at a given index

Parameters

i:int: the zero-based index into the text

Returns:AttributeSet

the AttributeSet of the character

getCharacterBounds

back to summary

public Rectangle getCharacterBounds(int i)

Implements javax.accessibility.AccessibleText.getCharacterBounds.

Determines the bounding box of the character at the given index into the string. The bounds are returned in local coordinates. If the index is invalid an empty rectangle is returned.

Parameters

i:int: the index into the String

Returns:Rectangle

the screen coordinates of the character's bounding box, if index is invalid return an empty rectangle.

getCharCount

back to summary

public int getCharCount()

Implements javax.accessibility.AccessibleText.getCharCount.

Returns the number of characters (valid indices)

Returns:int: the number of characters

getIndexAtPoint

back to summary

public int getIndexAtPoint(Point p)

Implements javax.accessibility.AccessibleText.getIndexAtPoint.

Given a point in local coordinates, return the zero-based index of the character under that Point. If the point is invalid, this method returns -1.

Parameters

p:Point: the Point in local coordinates

Returns:int

the zero-based index of the character under Point p; if Point is invalid return -1.

getLocale

back to summary

public Locale getLocale() throws IllegalComponentStateException

Implements abstract javax.accessibility.AccessibleContext.getLocale.

Gets the locale of the component. If the component does not have a locale, then the locale of its parent is returned.

Returns:Locale

this component's locale. If this component does not have a locale, the locale of its parent is returned.

Exceptions

IllegalComponentStateException:: If the Component does not have its own locale and has not yet been added to a containment hierarchy such that the locale can be determined from the containing parent.

getNoteLabelAccessibleText	back to summary
private AccessibleText getNoteLabelAccessibleText()

getPanelAccessibleContext	back to summary
private AccessibleContext getPanelAccessibleContext()

getParentAccessibleContext	back to summary
private AccessibleContext getParentAccessibleContext()

getSelectedText

back to summary

public String getSelectedText()

Implements javax.accessibility.AccessibleText.getSelectedText.

Returns the portion of the text that is selected.

Returns:String: the String portion of the text that is selected

getSelectionEnd

back to summary

public int getSelectionEnd()

Implements javax.accessibility.AccessibleText.getSelectionEnd.

Returns the end offset within the selected text. If there is no selection, but there is a caret, the start and end offsets will be the same.

Returns:int: the index into the text of the end of the selection

getSelectionStart

back to summary

public int getSelectionStart()

Implements javax.accessibility.AccessibleText.getSelectionStart.

Returns the start offset within the selected text. If there is no selection, but there is a caret, the start and end offsets will be the same.

Returns:int: the index into the text of the start of the selection

optionPaneCreated	back to summary
private void optionPaneCreated()

propertyChange back to summary

public void propertyChange(PropertyChangeEvent e)

Implements java.beans.PropertyChangeListener.propertyChange.

This method gets called when a bound property is changed.

Parameters

e:PropertyChangeEvent: A PropertyChangeEvent object describing the event source and the property that has changed. Must not be null.

Exceptions

NullPointerException:: if the parameter is null.

sameWindowAncestor	back to summary
private boolean sameWindowAncestor(Component src, Component dest)

stateChanged back to summary

public void stateChanged(ChangeEvent e)

Implements javax.swing.event.ChangeListener.stateChanged.

Invoked when the target of the listener has changed its state.

Parameters

e:ChangeEvent: a ChangeEvent object. Must not be null.

Exceptions

NullPointerException:: if the parameter is null.

javax.swing back to summary

private Class ProgressMonitor.ProgressOptionPane

Class Inheritance

extends JOptionPane

java.lang.Object
java.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JOptionPane
javax.swing.ProgressMonitor.ProgressOptionPane

Annotations

@SuppressWarnings:serial

Field Summary

Constructor Summary

Access	Constructor and Description
pack-priv	ProgressOptionPane(Object messageList)

Method Summary

Modifier and Type	Method and Description
public JDialog	createDialog(Component determines the frame in which the dialog is displayed; if the `parentComponent` has no `Frame`, a default `Frame` is used parentComponent, String the title string for the dialog title) Overrides javax.swing.JOptionPane.createDialog. Creates and returns a new `JDialog` wrapping `this` centered on the `parentComponent` in the `parentComponent`'s frame.
public AccessibleContext	Returns: the AccessibleContext for the ProgressOptionPane getAccessibleContext() Overrides javax.swing.JOptionPane.getAccessibleContext. Implements javax.accessibility.Accessible.getAccessibleContext. Gets the AccessibleContext for the ProgressOptionPane
private AccessibleContext	getAccessibleJOptionPane()
public int	getMaxCharactersPerLineCount() Overrides javax.swing.JOptionPane.getMaxCharactersPerLineCount. Returns the maximum number of characters to place on a line in a message.

Inherited from javax.swing.JOptionPane:: createDialog createInternalFrame getDesktopPaneForComponent getFrameForComponent getIcon getInitialSelectionValue getInitialValue getInputValue getMessage getMessageType getOptions getOptionType getRootFrame getSelectionValues getUI getUIClassID getValue getWantsInput getWindowForComponent paramString selectInitialValue setIcon setInitialSelectionValue setInitialValue setInputValue setMessage setMessageType setOptions setOptionType setRootFrame setSelectionValues setUI setValue setWantsInput showConfirmDialog showConfirmDialog showConfirmDialog showConfirmDialog showInputDialog showInputDialog showInputDialog showInputDialog showInputDialog showInputDialog showInternalConfirmDialog showInternalConfirmDialog showInternalConfirmDialog showInternalConfirmDialog showInternalInputDialog showInternalInputDialog showInternalInputDialog showInternalMessageDialog showInternalMessageDialog showInternalMessageDialog showInternalOptionDialog showMessageDialog showMessageDialog showMessageDialog showOptionDialog updateUI

Constructor Detail

ProgressOptionPane	back to summary
pack-priv ProgressOptionPane(Object messageList)

Method Detail

createDialog back to summary

public JDialog createDialog(Component parentComponent, String title)

Overrides javax.swing.JOptionPane.createDialog.

Doc from javax.swing.JOptionPane.createDialog.

Creates and returns a new JDialog wrapping this centered on the parentComponent in the parentComponent's frame. title is the title of the returned dialog. The returned JDialog will not be resizable by the user, however programs can invoke setResizable on the JDialog instance to change this property. The returned JDialog will be set up such that once it is closed, or the user clicks on one of the buttons, the optionpane's value property will be set accordingly and the dialog will be closed. Each time the dialog is made visible, it will reset the option pane's value property to JOptionPane.UNINITIALIZED_VALUE to ensure the user's subsequent action closes the dialog properly.

Parameters

parentComponent:Component: determines the frame in which the dialog is displayed; if the parentComponent has no Frame, a default Frame is used
title:String: the title string for the dialog

Returns:JDialog

a new JDialog containing this instance

getAccessibleContext

back to summary

public AccessibleContext getAccessibleContext()

Overrides javax.swing.JOptionPane.getAccessibleContext.

Implements javax.accessibility.Accessible.getAccessibleContext.

Gets the AccessibleContext for the ProgressOptionPane

Returns:AccessibleContext: the AccessibleContext for the ProgressOptionPane
Since: 1.5

getAccessibleJOptionPane	back to summary
private AccessibleContext getAccessibleJOptionPane()

getMaxCharactersPerLineCount back to summary

public int getMaxCharactersPerLineCount()

Overrides javax.swing.JOptionPane.getMaxCharactersPerLineCount.

Doc from javax.swing.JOptionPane.getMaxCharactersPerLineCount.

Returns the maximum number of characters to place on a line in a message. Default is to return Integer.MAX_VALUE. The value can be changed by overriding this method in a subclass.

Returns:int: an integer giving the maximum number of characters on a line

public Class ProgressMonitor

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class ProgressMonitor.AccessibleProgressMonitor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ProgressMonitor.ProgressOptionPane

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail