pax_global_header 0000666 0000000 0000000 00000000064 13336753554 0014530 g ustar 00root root 0000000 0000000 52 comment=ad579bd9ea7d64d5ea908f44ee50b42ed5fe55f6
mnemonicsetter-mnemonicsetter_0.6/ 0000775 0000000 0000000 00000000000 13336753554 0017545 5 ustar 00root root 0000000 0000000 mnemonicsetter-mnemonicsetter_0.6/.gitignore 0000664 0000000 0000000 00000000066 13336753554 0021537 0 ustar 00root root 0000000 0000000 /.gradle
/bin
/.classpath
/.project
/.settings
/build
mnemonicsetter-mnemonicsetter_0.6/LICENSE 0000664 0000000 0000000 00000026135 13336753554 0020561 0 ustar 00root root 0000000 0000000 Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "{}"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright {yyyy} {name of copyright owner}
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
mnemonicsetter-mnemonicsetter_0.6/README.md 0000664 0000000 0000000 00000001766 13336753554 0021036 0 ustar 00root root 0000000 0000000 # mnemonicsetter
Automatically assigns mnemonics to menu items and toolbar elements.
Use it just like `MnemonicSetter.INSTANCE.setComponentMnemonics(menubar, toolbar)`.
All items belonging to given elements are given different mnemonic letters if possible.
You can also attach `MnemonicSetter.INSTANCE` to a popup menu as a PopupMenuListener
so that mnemonics are automatically calculated when the popup menu becomes visible.
### Maven configuration
```
false
bintray-freeplane-maven
bintray
https://dl.bintray.com/freeplane/freeplane
org.dpolivaev.mnemonicsetter
mnemonicsetter
0.4
pom
```
### Gradle configuration
```
repositories {
maven { url "http://dl.bintray.com/freeplane/freeplane" }
}
dependencies {
compile 'org.dpolivaev.mnemonicsetter:mnemonicsetter:0.4'
}
```
mnemonicsetter-mnemonicsetter_0.6/build.gradle 0000664 0000000 0000000 00000002622 13336753554 0022026 0 ustar 00root root 0000000 0000000 plugins {
id "com.jfrog.bintray" version "1.6"
}
repositories {
jcenter()
}
apply plugin: 'java'
apply plugin: 'eclipse'
apply plugin: 'maven-publish'
targetCompatibility='1.7'
sourceCompatibility='1.7'
group 'org.dpolivaev.mnemonicsetter'
version='0.6'
bintray {
user = System.getenv('BINTRAY_USER')
key = System.getenv('BINTRAY_KEY')
publications = ['mnemonicsetter']
pkg {
repo = 'freeplane'
name = 'mnemonicsetter'
userOrg = 'freeplane'
licenses = ['Apache-2.0']
vcsUrl = 'https://github.com/dpolivaev/mnemonicsetter.git'
version {
name = project.version
}
}
}
task sourceJar(type: Jar, dependsOn: classes) {
classifier = 'sources'
from sourceSets.main.allSource
}
task javadocJar(type: Jar, dependsOn: javadoc) {
classifier = 'javadoc'
from javadoc.destinationDir
}
publishing {
publications {
mnemonicsetter(MavenPublication) {
from components.java
artifactId 'mnemonicsetter'
artifact sourceJar {
classifier "sources"
}
artifact javadocJar {
classifier "javadoc"
}
}
}
repositories {
maven { url "${project.gradle.gradleUserHomeDir}/local-artifacts" }
}
}
dependencies {
testCompile 'junit:junit:4.12',
'org.hamcrest:hamcrest-all:1.3',
'org.mockito:mockito-all:1.10.19'
}
mnemonicsetter-mnemonicsetter_0.6/src/ 0000775 0000000 0000000 00000000000 13336753554 0020334 5 ustar 00root root 0000000 0000000 mnemonicsetter-mnemonicsetter_0.6/src/main/ 0000775 0000000 0000000 00000000000 13336753554 0021260 5 ustar 00root root 0000000 0000000 mnemonicsetter-mnemonicsetter_0.6/src/main/java/ 0000775 0000000 0000000 00000000000 13336753554 0022201 5 ustar 00root root 0000000 0000000 mnemonicsetter-mnemonicsetter_0.6/src/main/java/org/ 0000775 0000000 0000000 00000000000 13336753554 0022770 5 ustar 00root root 0000000 0000000 mnemonicsetter-mnemonicsetter_0.6/src/main/java/org/dpolivaev/ 0000775 0000000 0000000 00000000000 13336753554 0024761 5 ustar 00root root 0000000 0000000 mnemonicsetter-mnemonicsetter_0.6/src/main/java/org/dpolivaev/mnemonicsetter/ 0000775 0000000 0000000 00000000000 13336753554 0030015 5 ustar 00root root 0000000 0000000 ActionNameMnemonicHolder.java 0000664 0000000 0000000 00000003416 13336753554 0035447 0 ustar 00root root 0000000 0000000 mnemonicsetter-mnemonicsetter_0.6/src/main/java/org/dpolivaev/mnemonicsetter /*
* Copyright (C) 2016 Dimitry Polivaev
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.dpolivaev.mnemonicsetter;
import java.awt.event.KeyEvent;
import javax.swing.Action;
public class ActionNameMnemonicHolder implements INameMnemonicHolder {
final private Action action;
public ActionNameMnemonicHolder(final Action action) {
super();
this.action = action;
}
public String getText() {
return (String) action.getValue(Action.NAME);
}
public void setDisplayedMnemonicIndex(final int mnemoSignIndex) {
action.putValue("SwingDisplayedMnemonicIndexKey", mnemoSignIndex);
}
public void setMnemonic(final char charAfterMnemoSign) {
final int keyCode = KeyEvent.getExtendedKeyCodeForChar((int) charAfterMnemoSign);
setMnemonic(keyCode);
}
public void setMnemonic(final int keyCode) {
action.putValue(Action.MNEMONIC_KEY, keyCode);
}
public void setText(final String text) {
action.putValue(Action.NAME, text);
}
@Override
public int getMnemonic() {
final Object mnemonic = action.getValue(Action.MNEMONIC_KEY);
if(mnemonic instanceof Integer)
return ((Integer)mnemonic).intValue();
else
return 0;
}
@Override
public boolean hasAccelerator() {
return action.getValue(Action.ACCELERATOR_KEY) != null;
}
} ButtonNameMnemonicHolder.java 0000664 0000000 0000000 00000003422 13336753554 0035502 0 ustar 00root root 0000000 0000000 mnemonicsetter-mnemonicsetter_0.6/src/main/java/org/dpolivaev/mnemonicsetter /*
* Copyright (C) 2016 Dimitry Polivaev
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.dpolivaev.mnemonicsetter;
import java.awt.event.KeyEvent;
import javax.swing.AbstractButton;
public class ButtonNameMnemonicHolder implements INameMnemonicHolder {
final private AbstractButton btn;
public ButtonNameMnemonicHolder(final AbstractButton btn) {
super();
this.btn = btn;
}
public String getText() {
return btn.getText();
}
public void setDisplayedMnemonicIndex(final int mnemoSignIndex) {
btn.setDisplayedMnemonicIndex(mnemoSignIndex);
}
public void setMnemonic(final char charAfterMnemoSign) {
final int keyCode = KeyEvent.getExtendedKeyCodeForChar(charAfterMnemoSign);
setMnemonic(keyCode);
}
public void setMnemonic(final int keyCode) {
btn.setMnemonic(keyCode);
}
public void setText(final String text) {
btn.setText(text);
}
@Override
public int getMnemonic() {
return btn.getMnemonic();
}
@Override
public String toString() {
final int mnemonic = getMnemonic();
final String text = getText();
return "ButtonNameMnemonicHolder [getText()=" + text + (mnemonic != 0 ? ", getMnemonic()=" + KeyEvent.getKeyText(mnemonic) + "]" : "");
}
@Override
public boolean hasAccelerator() {
return false;
}
} INameMnemonicHolder.java 0000664 0000000 0000000 00000001650 13336753554 0034420 0 ustar 00root root 0000000 0000000 mnemonicsetter-mnemonicsetter_0.6/src/main/java/org/dpolivaev/mnemonicsetter /*
* Copyright (C) 2016 Dimitry Polivaev
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.dpolivaev.mnemonicsetter;
public interface INameMnemonicHolder {
String getText();
void setDisplayedMnemonicIndex(int mnemoSignIndex);
void setMnemonic(char charAfterMnemoSign);
void setText(String replaceAll);
int getMnemonic();
void setMnemonic(int key);
boolean hasAccelerator();
} mnemonicsetter-mnemonicsetter_0.6/src/main/java/org/dpolivaev/mnemonicsetter/ItemMnemonicSetter.java0000664 0000000 0000000 00000014674 13336753554 0034447 0 ustar 00root root 0000000 0000000 /*
* Copyright (C) 2016 Dimitry Polivaev
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.dpolivaev.mnemonicsetter;
import java.awt.event.KeyEvent;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.regex.Pattern;
class ItemMnemonicSetter {
final static private Pattern CAN_HAVE_MNEMONICS = Pattern.compile("\\p{L}");
private final INameMnemonicHolder[] mnemonicHolders;
private Collection blockedMnemonics;
static ItemMnemonicSetter of(INameMnemonicHolder... mnemonicHolders) {
return of(Arrays.asList(mnemonicHolders));
}
static ItemMnemonicSetter of(List mnemonicHolders) {
final ArrayList validHolders = new ArrayList(mnemonicHolders.size());
for(INameMnemonicHolder holder :mnemonicHolders)
if(canHaveMnemonics(holder))
validHolders.add(holder);
final INameMnemonicHolder[] array = validHolders.toArray(new INameMnemonicHolder[validHolders.size()]);
return new ItemMnemonicSetter(array);
}
private static boolean canHaveMnemonics(INameMnemonicHolder holder) {
final String text = holder.getText();
return text != null && CAN_HAVE_MNEMONICS.matcher(text).find();
}
private ItemMnemonicSetter(INameMnemonicHolder[] mnemonicHolders) {
this.mnemonicHolders = mnemonicHolders;
blockedMnemonics = Collections.emptyList();
}
public void setMnemonics() {
final Map usedMnemonics = extractUsedMnemonics(mnemonicHolders);
if(usedMnemonics.size() - blockedMnemonics.size() < mnemonicHolders.length) {
final Map mnemonicSet = findMnemonics(usedMnemonics, 0, 0);
setMnemonics(mnemonicSet);
}
}
private void setMnemonics(final Map setMnemonics) {
for(Map.Entry holderMnemonic : setMnemonics.entrySet()) {
final INameMnemonicHolder target = holderMnemonic.getValue();
if(target != null)
target.setMnemonic(holderMnemonic.getKey());
}
}
private Map findMnemonics(final Map usedMnemonics, int holderIndex, int characterIndex) {
if(holderIndex >= mnemonicHolders.length)
return usedMnemonics;
final INameMnemonicHolder holder = mnemonicHolders[holderIndex];
final boolean holderHasNoMnemonics = ! usedMnemonics.containsKey(holder.getMnemonic());
if(holderHasNoMnemonics) {
final String text = holder.getText();
if(text.length() > characterIndex) {
return findUnsetMnemonics(usedMnemonics, holderIndex, characterIndex);
}
return findMnemonics(usedMnemonics, holderIndex + 1, 0);
}
return findMnemonics(usedMnemonics, holderIndex + 1, 0);
}
private Map findUnsetMnemonics(final Map usedMnemonics, int holderIndex, int characterIndex) {
final INameMnemonicHolder holder = mnemonicHolders[holderIndex];
final String text = holder.getText();
final char character = text.charAt(characterIndex);
final int keyCode = KeyEvent.getExtendedKeyCodeForChar(character);
if(! usedMnemonics.containsKey(keyCode) && Character.isAlphabetic(character)
&& text.toLowerCase().indexOf(Character.toLowerCase(character)) == characterIndex) {
final Map mnemonicsWithNewCharacter = new MnemonicMap(usedMnemonics);
mnemonicsWithNewCharacter.put(keyCode, holder);
final Map allMnemonics = findMnemonics(mnemonicsWithNewCharacter, holderIndex + 1, 0);
return allMnemonics;
} else {
final Map allMnemonics = findMnemonics(usedMnemonics, holderIndex, characterIndex + 1);
return allMnemonics;
}
}
private Map extractUsedMnemonics(INameMnemonicHolder... mnemonicHolders) {
final Map usedMnemonics = new MnemonicMap();
for(Integer blockedMnemonic : blockedMnemonics)
usedMnemonics.put(blockedMnemonic, null);
for(INameMnemonicHolder holder : mnemonicHolders){
final Integer mnemonic = holder.getMnemonic();
if(mnemonic != 0) {
if(! usedMnemonics.containsKey(mnemonic))
usedMnemonics.put(mnemonic, holder);
else {
holder.setMnemonic(0);
holder.setDisplayedMnemonicIndex(-1);
}
}
}
Arrays.sort(mnemonicHolders, new Comparator() {
@Override
public int compare(INameMnemonicHolder o1, INameMnemonicHolder o2) {
boolean o1HasMnemonics = o1.getMnemonic() > 0;
boolean o2HasMnemonics = o2.getMnemonic() > 0;
if(o1HasMnemonics)
if(o2HasMnemonics)
return 0;
else
return -1;
else
if(o2HasMnemonics)
return 1;
else {
boolean o1HasAccelerator = o1. hasAccelerator();
boolean o2HasAccelerator = o2. hasAccelerator();
if(o1HasAccelerator && ! o2HasAccelerator)
return 1;
else if(! o1HasAccelerator && o2HasAccelerator)
return -1;
else
return o1.getText().length() - o2.getText().length();
}
}
});
return usedMnemonics;
}
public ItemMnemonicSetter notUsing(Collection blockedMnemonics) {
this.blockedMnemonics = blockedMnemonics;
return this;
}
}
@SuppressWarnings("serial")
class MnemonicMap extends LinkedHashMap {
public MnemonicMap() {
super();
}
public MnemonicMap(Map m) {
super(m);
}
@Override
public String toString() {
final StringBuilder stringBuilder = new StringBuilder("MnemonicMap"
+ "(" + size() + ") {");
for(Map.Entry entry : entrySet()){
stringBuilder
.append(entry.getValue().getText())
.append(" -> ")
.append(KeyEvent.getKeyText(entry.getKey()))
.append("\n");
}
return stringBuilder.append("}").toString();
}
}
MenuItemMnemonicHolder.java 0000664 0000000 0000000 00000001743 13336753554 0035155 0 ustar 00root root 0000000 0000000 mnemonicsetter-mnemonicsetter_0.6/src/main/java/org/dpolivaev/mnemonicsetter /*
* Copyright (C) 2016 Dimitry Polivaev
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.dpolivaev.mnemonicsetter;
import javax.swing.JMenuItem;
class MenuItemMnemonicHolder extends ButtonNameMnemonicHolder {
final private JMenuItem menuItem;
public MenuItemMnemonicHolder(JMenuItem menuItem) {
super(menuItem);
this.menuItem = menuItem;
}
@Override
public boolean hasAccelerator() {
return menuItem.getAccelerator() != null;
}
} mnemonicsetter-mnemonicsetter_0.6/src/main/java/org/dpolivaev/mnemonicsetter/MnemonicSetter.java 0000664 0000000 0000000 00000007543 13336753554 0033625 0 ustar 00root root 0000000 0000000 /*
Copyright (C) 2016 Dimitry Polivaev
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package org.dpolivaev.mnemonicsetter;
import java.awt.Component;
import java.awt.Container;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import javax.swing.AbstractButton;
import javax.swing.JMenuBar;
import javax.swing.JMenuItem;
import javax.swing.event.PopupMenuEvent;
import javax.swing.event.PopupMenuListener;
/**
* Automatically assigns mnemonics to menu items and toolbar elements.
*
* Use it just like MnemonicSetter.INSTANCE.setComponentMnemonics(menubar, toolbar).
* You can also attach it to a popup menu as a PopupMenuListener
* so that mnemonics are automatically calculated when the popup menu becomes visible.
*/
public class MnemonicSetter implements PopupMenuListener{
final static private boolean IS_MAC_OS = System.getProperty("os.name").startsWith("Mac OS");
final static public MnemonicSetter INSTANCE = new MnemonicSetter();
@Override
public void popupMenuWillBecomeVisible(PopupMenuEvent e) {
final Container popupMenu = (Container) e.getSource();
setComponentMnemonics(popupMenu);
}
public void setComponentMnemonics(final Container... containers) {
if(IS_MAC_OS)
return; // Mac OS generally does not support mnemonics
int componentCount = 0;
for(Container container : containers) {
componentCount += countComponents(container);
}
final Collection keyCodesUsedInMenus = new HashSet<>();
final ArrayList mnemonicHolders = new ArrayList(componentCount);
for(Container container : containers) {
addComponents(container, keyCodesUsedInMenus, mnemonicHolders);
}
final ItemMnemonicSetter mnemonicSetter = ItemMnemonicSetter.of(mnemonicHolders).notUsing(keyCodesUsedInMenus);
mnemonicSetter.setMnemonics();
}
private void addComponents(Container container, final Collection keyCodesUsedInMenus,
final ArrayList mnemonicHolders) {
if(container instanceof JMenuBar) {
final Collection keyCodesUsedInMenu = UsedAltAcceleratorsFinder.INSTANCE.findUsedKeyCodes((JMenuBar) container);
keyCodesUsedInMenus.addAll(keyCodesUsedInMenu);
}
final Component[] components = container.getComponents();
for(Component component :components)
if(component instanceof JMenuItem) {
final JMenuItem item = (JMenuItem) component;
mnemonicHolders.add(new MenuItemMnemonicHolder(item));
}
else if(component instanceof AbstractButton) {
final AbstractButton button = (AbstractButton) component;
mnemonicHolders.add(new ButtonNameMnemonicHolder(button));
}
else if(component instanceof Container) {
addComponents((Container) component, keyCodesUsedInMenus, mnemonicHolders);
}
}
private int countComponents(Container container) {
if(container instanceof JMenuBar) {
return container.getComponentCount();
}
int count = 0;
final Component[] components = container.getComponents();
for(Component component :components) {
if(component instanceof JMenuItem || component instanceof AbstractButton) {
count++;
}
else if(component instanceof Container) {
count += countComponents((Container) component);
}
}
return count;
}
@Override
public void popupMenuWillBecomeInvisible(PopupMenuEvent e) {
}
@Override
public void popupMenuCanceled(PopupMenuEvent e) {
}
}
UsedAltAcceleratorsFinder.java 0000664 0000000 0000000 00000002635 13336753554 0035630 0 ustar 00root root 0000000 0000000 mnemonicsetter-mnemonicsetter_0.6/src/main/java/org/dpolivaev/mnemonicsetter package org.dpolivaev.mnemonicsetter;
import java.awt.Component;
import java.awt.event.KeyEvent;
import java.util.Collection;
import java.util.HashSet;
import javax.swing.JMenu;
import javax.swing.JMenuBar;
import javax.swing.JMenuItem;
import javax.swing.KeyStroke;
public class UsedAltAcceleratorsFinder {
private HashSet hashSet;
static public UsedAltAcceleratorsFinder INSTANCE = new UsedAltAcceleratorsFinder();
public Collection findUsedKeyCodes(JMenuBar menuBar) {
hashSet = new HashSet<>();
for(int i = 0; i < menuBar.getMenuCount(); i++) {
final JMenu menu = menuBar.getMenu(i);
findUsedMenuCodes(menu);
}
return hashSet;
}
private void findUsedMenuCodes(JMenu menu) {
for(int i = 0; i < menu.getMenuComponentCount(); i++) {
final Component menuComponent = menu.getMenuComponent(i);
if(menuComponent instanceof JMenu){
findUsedMenuCodes((JMenu) menuComponent);
}
if(menuComponent instanceof JMenuItem){
final KeyStroke accelerator = ((JMenuItem)menuComponent).getAccelerator();
if(accelerator != null) {
final int keyCode = accelerator.getKeyCode();
if (keyCode >= KeyEvent.VK_A && keyCode <= KeyEvent.VK_Z
&&(accelerator.getModifiers() & (KeyEvent.ALT_DOWN_MASK
| KeyEvent.CTRL_DOWN_MASK | KeyEvent.SHIFT_DOWN_MASK | KeyEvent.META_DOWN_MASK)) == KeyEvent.ALT_DOWN_MASK) {
hashSet.add(keyCode);
}
}
}
}
}
}
mnemonicsetter-mnemonicsetter_0.6/src/test/ 0000775 0000000 0000000 00000000000 13336753554 0021313 5 ustar 00root root 0000000 0000000 mnemonicsetter-mnemonicsetter_0.6/src/test/java/ 0000775 0000000 0000000 00000000000 13336753554 0022234 5 ustar 00root root 0000000 0000000 mnemonicsetter-mnemonicsetter_0.6/src/test/java/org/ 0000775 0000000 0000000 00000000000 13336753554 0023023 5 ustar 00root root 0000000 0000000 mnemonicsetter-mnemonicsetter_0.6/src/test/java/org/dpolivaev/ 0000775 0000000 0000000 00000000000 13336753554 0025014 5 ustar 00root root 0000000 0000000 mnemonicsetter-mnemonicsetter_0.6/src/test/java/org/dpolivaev/mnemonicsetter/ 0000775 0000000 0000000 00000000000 13336753554 0030050 5 ustar 00root root 0000000 0000000 ItemMnemonicSetterShould.java 0000664 0000000 0000000 00000013634 13336753554 0035575 0 ustar 00root root 0000000 0000000 mnemonicsetter-mnemonicsetter_0.6/src/test/java/org/dpolivaev/mnemonicsetter /*
* Copyright (C) 2016 Dimitry Polivaev
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.dpolivaev.mnemonicsetter;
import static org.junit.Assert.assertThat;
import java.awt.event.KeyEvent;
import java.util.Collections;
import org.hamcrest.CoreMatchers;
import org.junit.Test;
public class ItemMnemonicSetterShould {
static class MnemonicHolder implements INameMnemonicHolder{
private String text;
private int keyCode;
public MnemonicHolder(String text, char character) {
super();
setText(text);
setMnemonic(character);
}
public MnemonicHolder(String text) {
setText(text);
}
@Override
public String getText() {
return text;
}
@Override
public void setDisplayedMnemonicIndex(int mnemoSignIndex) {
}
@Override
public void setMnemonic(char character) {
final int keyCode = KeyEvent.getExtendedKeyCodeForChar(character);
setMnemonic(keyCode);
}
@Override
public void setMnemonic(final int keyCode) {
this.keyCode = keyCode;
}
@Override
public void setText(String text) {
this.text = text;
}
@Override
public int getMnemonic() {
return keyCode;
}
@Override
public boolean hasAccelerator() {
return false;
}
}
private void assertMnemonic(final MnemonicHolder mnemonicHolder, char character) {
final int keyCode = character != 0 ? KeyEvent.getExtendedKeyCodeForChar(character) : 0;
final int mnemonic = mnemonicHolder.getMnemonic();
if(keyCode == 0)
assertThat(mnemonic, CoreMatchers.equalTo(keyCode));
else {
final String mnemonicCharacter = KeyEvent.getKeyText(mnemonic);
final String expectedCharacter = KeyEvent.getKeyText(keyCode);
assertThat(mnemonicCharacter, CoreMatchers.equalTo(expectedCharacter));
}
}
@Test
public void assignsFirstLetter() throws Exception {
final MnemonicHolder mnemonicHolderA = new MnemonicHolder("A");
ItemMnemonicSetter.of(mnemonicHolderA).setMnemonics();
assertMnemonic(mnemonicHolderA, 'A');
}
@Test
public void skipsSpaces() throws Exception {
final MnemonicHolder mnemonicHolderA = new MnemonicHolder(" A");
ItemMnemonicSetter.of(mnemonicHolderA).setMnemonics();
assertMnemonic(mnemonicHolderA, 'A');
}
@Test
public void assignsSecondLetter_IfFirstLetterIsAlreadyAssigned() throws Exception {
final MnemonicHolder mnemonicHolderAB = new MnemonicHolder("AB");
final MnemonicHolder mnemonicHolderA = new MnemonicHolder("A", 'A');
ItemMnemonicSetter.of(mnemonicHolderAB, mnemonicHolderA).setMnemonics();
assertMnemonic(mnemonicHolderA, 'A');
assertMnemonic(mnemonicHolderAB, 'B');
}
@Test
public void assignsSecondLetter_IfFirstLetterIsAlreadyUsed() throws Exception {
final MnemonicHolder mnemonicHolderAB = new MnemonicHolder("AB");
ItemMnemonicSetter.of(mnemonicHolderAB).notUsing(Collections.singleton(KeyEvent.VK_A)).setMnemonics();
assertMnemonic(mnemonicHolderAB, 'B');
}
@Test
public void assignsSecondLetter_IfFirstLetterLowerCaseIsAlreadyAssigned() throws Exception {
final MnemonicHolder mnemonicHolderAB = new MnemonicHolder("ab");
final MnemonicHolder mnemonicHolderA = new MnemonicHolder("A", 'A');
ItemMnemonicSetter.of(mnemonicHolderAB, mnemonicHolderA).setMnemonics();
assertMnemonic(mnemonicHolderA, 'A');
assertMnemonic(mnemonicHolderAB, 'B');
}
@Test
public void assignsFirstLetter_ifItIsNotAssignedYet() throws Exception {
final MnemonicHolder mnemonicHolderAB = new MnemonicHolder("AB");
final MnemonicHolder mnemonicHolderA = new MnemonicHolder("C");
ItemMnemonicSetter.of(mnemonicHolderAB, mnemonicHolderA).setMnemonics();
assertMnemonic(mnemonicHolderAB, 'A');
}
@Test
public void assignsFirstLetter_toSecondHolder() throws Exception {
final MnemonicHolder mnemonicHolderAB = new MnemonicHolder("AB");
final MnemonicHolder mnemonicHolderC = new MnemonicHolder("C");
ItemMnemonicSetter.of(mnemonicHolderAB, mnemonicHolderC).setMnemonics();
assertMnemonic(mnemonicHolderAB, 'A');
assertMnemonic(mnemonicHolderC, 'C');
}
@Test
public void assignsSecondLetter_toSecondHolder() throws Exception {
final MnemonicHolder mnemonicHolderAB = new MnemonicHolder("AB");
final MnemonicHolder mnemonicHolderAC = new MnemonicHolder("AC");
ItemMnemonicSetter.of(mnemonicHolderAB, mnemonicHolderAC).setMnemonics();
assertMnemonic(mnemonicHolderAB, 'A');
assertMnemonic(mnemonicHolderAC, 'C');
}
@Test
public void assignsNoLetter_ifAllLettersAreAlreadyAssigned() throws Exception {
final MnemonicHolder mnemonicHolderA1 = new MnemonicHolder("a");
final MnemonicHolder mnemonicHolderA2 = new MnemonicHolder("a", 'A');
ItemMnemonicSetter.of(mnemonicHolderA1, mnemonicHolderA2).setMnemonics();
assertMnemonic(mnemonicHolderA1, '\0');
assertMnemonic(mnemonicHolderA2, 'A');
}
@Test
public void assignsSecondLetter_toFirstHolder() throws Exception {
final MnemonicHolder mnemonicHolderAB = new MnemonicHolder("AB");
final MnemonicHolder mnemonicHolderA = new MnemonicHolder("A");
ItemMnemonicSetter.of(mnemonicHolderAB, mnemonicHolderA).setMnemonics();
assertMnemonic(mnemonicHolderAB, 'B');
assertMnemonic(mnemonicHolderA, 'A');
}
@Test
public void assignsNoLetter_toSecondHolder() throws Exception {
final MnemonicHolder mnemonicHolderA1 = new MnemonicHolder("a");
final MnemonicHolder mnemonicHolderA2 = new MnemonicHolder("a");
ItemMnemonicSetter.of(mnemonicHolderA1, mnemonicHolderA2).setMnemonics();
assertMnemonic(mnemonicHolderA1, 'A');
assertMnemonic(mnemonicHolderA2, '\0');
}
}
UsedAltAcceleratorsFinderShould.java 0000664 0000000 0000000 00000005510 13336753554 0037035 0 ustar 00root root 0000000 0000000 mnemonicsetter-mnemonicsetter_0.6/src/test/java/org/dpolivaev/mnemonicsetter package org.dpolivaev.mnemonicsetter;
import static org.junit.Assert.assertTrue;
import java.awt.event.KeyEvent;
import java.util.Arrays;
import javax.swing.JMenu;
import javax.swing.JMenuBar;
import javax.swing.JMenuItem;
import javax.swing.KeyStroke;
import org.junit.Before;
import org.junit.Test;
public class UsedAltAcceleratorsFinderShould {
private UsedAltAcceleratorsFinder usedAltAcceleratorsFinder;
private JMenuBar menuBar;
private JMenu menu;
private JMenuItem menuItem;
@Before
public void setup() {
usedAltAcceleratorsFinder = new UsedAltAcceleratorsFinder();
menuBar = new JMenuBar();
menu = new JMenu();
menuBar.add(menu);
menuItem = new JMenuItem();
menu.add(menuItem);
}
@Test
public void returnsEmptyCollectionIfNoAcceleratorsAreFound() throws Exception {
assertTrue(usedAltAcceleratorsFinder.findUsedKeyCodes(menuBar).isEmpty());
}
@Test
public void returnsFoundAcceleratorIfAcceleratorsAreFound() throws Exception {
JMenuItem menuItem2 = new JMenuItem();
JMenu menu2 = new JMenu();
menu2.add(menuItem2);
menu.add(menu2);
JMenu menu3 = new JMenu();
JMenuItem menuItem3 = new JMenuItem();
menu3.add(menuItem3);
menuBar.add(menu3);
JMenuItem menuItem4 = new JMenuItem();
menu.add(menuItem4);
menuItem.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_A, KeyEvent.ALT_DOWN_MASK));
menuItem2.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_B, KeyEvent.ALT_DOWN_MASK));
menuItem3.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_C, KeyEvent.ALT_DOWN_MASK));
menuItem4.setAccelerator(KeyStroke.getKeyStroke(KeyEvent.VK_D, KeyEvent.ALT_DOWN_MASK));
assertTrue(usedAltAcceleratorsFinder.findUsedKeyCodes(menuBar).containsAll(Arrays.asList(KeyEvent.VK_A, KeyEvent.VK_B, KeyEvent.VK_C, KeyEvent.VK_D)));
}
@Test
public void returnsFoundAcceleratorIfShiftIsRequired() throws Exception {
final int extendedKeyCodeForCharA = KeyEvent.getExtendedKeyCodeForChar('A');
menuItem.setAccelerator(KeyStroke.getKeyStroke(extendedKeyCodeForCharA, KeyEvent.ALT_DOWN_MASK|KeyEvent.SHIFT_DOWN_MASK));
assertTrue(usedAltAcceleratorsFinder.findUsedKeyCodes(menuBar).isEmpty());
}
@Test
public void returnsFoundAcceleratorIfControlIsRequired() throws Exception {
final int extendedKeyCodeForCharA = KeyEvent.getExtendedKeyCodeForChar('A');
menuItem.setAccelerator(KeyStroke.getKeyStroke(extendedKeyCodeForCharA, KeyEvent.ALT_DOWN_MASK|KeyEvent.CTRL_DOWN_MASK));
assertTrue(usedAltAcceleratorsFinder.findUsedKeyCodes(menuBar).isEmpty());
}
@Test
public void returnsFoundAcceleratorIfMetaIsRequired() throws Exception {
final int extendedKeyCodeForCharA = KeyEvent.getExtendedKeyCodeForChar('A');
menuItem.setAccelerator(KeyStroke.getKeyStroke(extendedKeyCodeForCharA, KeyEvent.ALT_DOWN_MASK|KeyEvent.META_DOWN_MASK));
assertTrue(usedAltAcceleratorsFinder.findUsedKeyCodes(menuBar).isEmpty());
}
}