com.codename1.components.SpanButton Maven / Gradle / Ivy
/*
* Copyright (c) 2012, Codename One and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Codename One designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Codename One through http://www.codenameone.com/ if you
* need additional information or have any questions.
*/
package com.codename1.components;
import com.codename1.ui.Button;
import static com.codename1.ui.CN.EAST;
import static com.codename1.ui.CN.WEST;
import com.codename1.ui.Command;
import com.codename1.ui.Component;
import static com.codename1.ui.ComponentSelector.$;
import com.codename1.ui.Container;
import com.codename1.ui.Font;
import com.codename1.ui.Image;
import com.codename1.ui.Label;
import com.codename1.ui.SelectableIconHolder;
import com.codename1.ui.TextArea;
import com.codename1.ui.TextHolder;
import com.codename1.ui.events.ActionListener;
import com.codename1.ui.events.ActionSource;
import com.codename1.ui.layouts.BorderLayout;
import com.codename1.ui.layouts.BoxLayout;
import com.codename1.ui.plaf.Style;
import com.codename1.ui.plaf.UIManager;
/**
*
* A complex button similar to MultiButton that breaks lines automatically and
* looks like a regular button (more or less). Unlike the multi button the span
* button has the UIID style of a button.
*
* 
*
* @author Shai Almog
*/
public class SpanButton extends Container implements ActionSource, SelectableIconHolder, TextHolder {
private int gap = Label.getDefaultGap();
private Button actualButton;
private TextArea text;
private boolean shouldLocalize = true;
/**
* Default constructor will be useful when adding this to the GUI builder
*/
public SpanButton() {
this("");
}
/**
* Constructor accepting default text and uiid for the text
*
* @param txt the text
* @param textUiid the new text UIID
*/
public SpanButton(String txt, String textUiid) {
this(txt);
text.setUIID(textUiid);
}
/**
* Constructor accepting default text
*/
public SpanButton(String txt) {
setUIID("Button");
setLayout(new BorderLayout());
text = new TextArea(getUIManager().localize(txt, txt));
text.setColumns(100);
text.setUIID("Button");
text.setGrowByContent(true);
text.setEditable(false);
text.setFocusable(false);
text.setActAsLabel(true);
setFocusable(true);
removeBackground(text.getUnselectedStyle());
removeBackground(text.getSelectedStyle());
removeBackground(text.getPressedStyle());
removeBackground(text.getDisabledStyle());
actualButton = new Button();
actualButton.setUIID("icon");
addComponent(BorderLayout.WEST, actualButton);
Container center = BoxLayout.encloseYCenter(text);
center.getStyle().setMargin(0, 0, 0, 0);
center.getStyle().setPadding(0, 0, 0, 0);
addComponent(BorderLayout.CENTER, center);
setLeadComponent(actualButton);
updateGap();
}
@Override
public void styleChanged(String propertyName, Style source) {
super.styleChanged(propertyName, source);
if (Style.ICON_GAP.equals(propertyName)) {
int gap = source.getIconGap();
if (gap >= 0 && gap != getGap()) {
setGap(gap);
updateGap();
}
}
}
@Override
protected void initUnselectedStyle(Style unselectedStyle) {
super.initUnselectedStyle(unselectedStyle);
if (unselectedStyle.getIconGap() > 0) {
int gap = unselectedStyle.getIconGap();
if (gap != getGap()) {
setGap(unselectedStyle.getIconGap());
updateGap();
}
}
}
private void updateGap() {
if (getIcon() == null) {
$(actualButton).setMargin(0);
} else if (BorderLayout.NORTH.equals(getIconPosition())) {
$(actualButton).selectAllStyles().setMargin(0, 0, gap, 0);
} else if (BorderLayout.SOUTH.equals(getIconPosition())) {
$(actualButton).selectAllStyles().setMargin(gap, 0, 0, 0);
} else if (BorderLayout.EAST.equals(getIconPosition())) {
$(actualButton).selectAllStyles().setMargin(0, 0, 0, gap);
} else if (BorderLayout.WEST.equals(getIconPosition())) {
$(actualButton).selectAllStyles().setMargin(0, gap, 0, 0);
}
}
/**
* Returns the TextArea holding the actual text
* @return the component
*/
public TextArea getTextComponent() {
return text;
}
/**
* Sets the UIID for the actual text
*
* @param uiid the uiid
*/
public void setTextUIID(String uiid) {
text.setUIID(uiid);
}
/**
* Returns the uiid of the actual text
*
* @return the uiid
*/
public String getTextUIID() {
return text.getUIID();
}
@Override
public void setUIID(String id) {
super.setUIID(id);
if (id != null && id.length() > 0) {
String iconUIID = getUIManager().getIconUIIDFor(id);
if (iconUIID != null) {
setIconUIID(iconUIID);
}
}
}
@Override
protected void initLaf(UIManager uim) {
if(uim == getUIManager() && isInitialized()){
return;
}
super.initLaf(uim);
String uiid = getUIID();
if (uiid != null && uiid.length() >0) {
String iconUiid = uim.getIconUIIDFor(uiid);
if (iconUiid != null) {
setIconUIID(iconUiid);
}
}
}
/**
* Gets the component used for styling font icons on this SpanLabel.
* @return The component used for styling font icons on this SpanLabel.
* @since 7.0
*/
public Component getIconStyleComponent() {
return actualButton.getIconStyleComponent();
}
/**
* Returns the Style proxy object for the text of this span button.
*
* @return The Style object for the text of this span button.
*/
public Style getTextAllStyles() {
return text.getAllStyles();
}
/**
* Returns the Style object for the text of this span button.
*
* @return The Style object for the text of this span button.
*/
public Style getTextStyle() {
return text.getStyle();
}
/**
* Sets the uiid for the icon if present
*
* @param uiid the uiid for the icon
*/
public void setIconUIID(String uiid) {
actualButton.setUIID(uiid);
updateGap();
}
/**
* Returns the UIID for the icon
*
* @return the uiid
*/
public String getIconUIID() {
return actualButton.getUIID();
}
private void removeBackground(Style s) {
s.setBackgroundType(Style.BACKGROUND_NONE);
s.setBgImage(null);
s.setBorder(null);
s.setBgTransparency(0);
}
/**
* Set the text of the button
*
* @param t text of the button
*/
public void setText(String t) {
if (shouldLocalize) {
text.setText(getUIManager().localize(t, t));
} else {
text.setText(t);
}
}
/**
* Sets the icon for the button
*
* @param i the icon
*/
public void setIcon(Image i) {
actualButton.setIcon(i);
updateGap();
}
/**
* Returns the text of the button
*
* @return the text
*/
public String getText() {
return text.getText();
}
/**
* Returns the image of the icon
*
* @return the icon
*/
public Image getIcon() {
return actualButton.getIcon();
}
/**
* Binds long press listener to button events.
* @param l
* @since 7.0
*/
public void addLongPressListener(ActionListener l) {
actualButton.addLongPressListener(l);
}
/**
* Unbinds long press listener to button events.
* @param l
* @since 7.0
*/
public void removeLongPressListener(ActionListener l) {
actualButton.removeLongPressListener(l);
}
/**
* Binds an action listener to button events
*
* @param l the listener
*/
public void addActionListener(ActionListener l) {
actualButton.addActionListener(l);
}
/**
* Removes the listener from tracking button events
*
* @param l the listener
*/
public void removeActionListener(ActionListener l) {
actualButton.removeActionListener(l);
}
/**
* Sets the icon position based on border layout constraints
*
* @param s position either North/South/East/West
*/
public void setIconPosition(String t) {
removeComponent(actualButton);
addComponent(t, actualButton);
updateGap();
revalidateLater();
}
/**
* Returns the icon position based on border layout constraints
*
* @return position either North/South/East/West
*/
public String getIconPosition() {
return (String) getLayout().getComponentConstraint(actualButton);
}
/**
* Sets the command for the component
*
* @param cmd the command
*/
public void setCommand(Command cmd) {
actualButton.setCommand(cmd);
}
/**
* Returns the command instance of the button
*
* @return the command instance of the button
*/
public Command getCommand() {
return actualButton.getCommand();
}
/**
* {@inheritDoc}
*/
public String[] getPropertyNames() {
return new String[]{
"text", "icon", "iconPosition", "textUiid", "iconUiid"
};
}
/**
* {@inheritDoc}
*/
public Class[] getPropertyTypes() {
return new Class[]{
String.class, // text
Image.class, // icon
String.class, // iconPosition
String.class,
String.class
};
}
/**
* {@inheritDoc}
*/
public String[] getPropertyTypeNames() {
return new String[]{"String", "Image", "String", "String", "String"};
}
/**
* {@inheritDoc}
*/
public Object getPropertyValue(String name) {
if (name.equals("text")) {
return getText();
}
if (name.equals("icon")) {
return getIcon();
}
if (name.equals("iconPosition")) {
return getIconPosition();
}
if (name.equals("textUiid")) {
return getTextUIID();
}
if (name.equals("iconUiid")) {
return getIconUIID();
}
return null;
}
/**
* {@inheritDoc}
*/
public String setPropertyValue(String name, Object value) {
if (name.equals("text")) {
setText((String) value);
return null;
}
if (name.equals("icon")) {
setIcon((Image) value);
return null;
}
if (name.equals("iconPosition")) {
setIconPosition((String) value);
return null;
}
if (name.equals("textUiid")) {
setTextUIID((String) value);
return null;
}
if (name.equals("iconUiid")) {
setIconUIID((String) value);
return null;
}
return super.setPropertyValue(name, value);
}
/**
* Indicates if text should be localized when set to the component, by
* default all text is localized so this allows disabling automatic
* localization for a specific component.
*
* @return the shouldLocalize value
*/
public boolean isShouldLocalize() {
return shouldLocalize;
}
/**
* Indicates if text should be localized when set to the component, by
* default all text is localized so this allows disabling automatic
* localization for a specific component.
*
* @param shouldLocalize the shouldLocalize to set
*/
public void setShouldLocalize(boolean shouldLocalize) {
this.shouldLocalize = shouldLocalize;
}
/**
* Sets the pressed icon for the button
*
* @param i the icon
*/
public void setPressedIcon(Image i) {
actualButton.setPressedIcon(i);
}
/**
* Returns the pressed icon of the button
*
* @return the pressed icon
*/
public Image getPressedIcon() {
return actualButton.getPressedIcon();
}
/**
* Sets the rollover icon for the button
*
* @param i the icon
*/
public void setRolloverIcon(Image i) {
actualButton.setRolloverIcon(i);
}
/**
* Returns the rollover icon of the button
*
* @return the pressed icon
*/
public Image getRolloverIcon() {
return actualButton.getRolloverIcon();
}
/**
* Sets the disabled icon for the button
*
* @param i the icon
*/
public void setDisabledIcon(Image i) {
actualButton.setDisabledIcon(i);
}
/**
* Returns the disabled icon of the button
*
* @return the pressed icon
*/
public Image getDisabledIcon() {
return actualButton.getDisabledIcon();
}
/**
* Returns if this is an auto released Button. Auto released Buttons will
* are been disarmed when a drag is happening within the Button.
*
* @return true if it's an auto released Button.
*/
public boolean isAutoRelease() {
return actualButton.isAutoRelease();
}
/**
* Sets the auto released mode of this button, by default it's not an auto
* released Button
*/
public void setAutoRelease(boolean autoRelease) {
this.actualButton.setAutoRelease(autoRelease);
}
@Override
public void setWidth(int width) {
int w = getWidth();
if (w != width) {
// We need to update the textarea width whenever we set the width
// so that preferred height will be calculated correctly.
int newTextW = width;
String iconPos = getIconPosition();
if (getIcon() != null && EAST.equals(iconPos) || WEST.equals(iconPos)) {
newTextW -= actualButton.getOuterWidth();
}
newTextW -= getStyle().getHorizontalPadding();
newTextW -= text.getStyle().getHorizontalMargins();
text.setWidth(newTextW);
super.setWidth(width);
setShouldCalcPreferredSize(true);
}
}
@Override
public void setGap(int gap) {
if (gap != this.gap) {
this.gap = gap;
updateGap();
}
}
@Override
public int getGap() {
return gap;
}
/**
* {@inheritDoc }
*
*/
@Override
public void setTextPosition(int textPosition) {
switch (textPosition) {
case Component.TOP:
setIconPosition(BorderLayout.SOUTH);
break;
case Component.BOTTOM:
setIconPosition(BorderLayout.NORTH);
break;
case Component.LEFT:
setIconPosition(BorderLayout.EAST);
break;
case Component.RIGHT:
setIconPosition(BorderLayout.WEST);
break;
default:
setIconPosition(BorderLayout.EAST);
}
}
/**
* {@inheritDoc }
*
*/
@Override
public int getTextPosition() {
String iconPosition = getIconPosition();
if (BorderLayout.NORTH.equals(iconPosition)) {
return Component.BOTTOM;
}
if (BorderLayout.SOUTH.equals(iconPosition)) {
return Component.TOP;
}
if (BorderLayout.EAST.equals(iconPosition)) {
return Component.LEFT;
}
if (BorderLayout.WEST.equals(iconPosition)) {
return Component.RIGHT;
}
return Component.LEFT;
}
/**
* {@inheritDoc}
* @since 7.0
*/
@Override
public void setRolloverPressedIcon(Image arg0) {
actualButton.setRolloverPressedIcon(arg0);
}
/**
* {@inheritDoc }
* @since 7.0
*/
@Override
public Image getRolloverPressedIcon() {
return actualButton.getRolloverIcon();
}
/**
* {@inheritDoc }
* @since 7.0
*/
@Override
public Image getIconFromState() {
return actualButton.getIconFromState();
}
/**
* This method is shorthand for {@link com.codename1.ui.FontImage#setMaterialIcon(com.codename1.ui.Label, char)}
* @param c one of the constants from {@link com.codename1.ui.FontImage}
*/
public void setMaterialIcon(char c) {
actualButton.setMaterialIcon(c);
}
/**
* This method is shorthand for {@link com.codename1.ui.FontImage#setMaterialIcon(com.codename1.ui.Label, com.codename1.ui.Font, char)}
* @param c one of the constants from the font
*/
public void setFontIcon(Font font, char c) {
actualButton.setFontIcon(font, c);
}
/**
* This method is shorthand for {@link com.codename1.ui.FontImage#setMaterialIcon(com.codename1.ui.Label, char, float)}
* @param c one of the constants from {@link com.codename1.ui.FontImage}
* @param size the size of the icon in millimeters
*/
public void setMaterialIcon(char c, float size) {
actualButton.setMaterialIcon(c, size);
}
/**
* This method is shorthand for {@link com.codename1.ui.FontImage#setFontIcon(com.codename1.ui.Label, com.codename1.ui.Font, char, float)}
* @param c one of the constants from the font
* @param size the size of the icon in millimeters
*/
public void setFontIcon(Font font, char c, float size) {
actualButton.setFontIcon(font, c, size);
}
/**
* Returns the material icon assigned to this component or 0 if not applicable
* @return the material icon
*/
public char getMaterialIcon() {
return actualButton.getMaterialIcon();
}
/**
* Returns the font icon assigned to this component or 0 if not applicable
* @return the material icon
*/
public char getFontIcon() {
return actualButton.getFontIcon();
}
/**
* Returns the material icon size assigned to this component or 0/-1 if
* not applicable
* @return the material icon size
*/
public float getMaterialIconSize() {
return actualButton.getMaterialIconSize();
}
/**
* Returns the icon size assigned to this component or 0/-1 if
* not applicable
* @return the icon size
*/
public float getFontIconSize() {
return actualButton.getFontIconSize();
}
/**
* Returns the font for the icon font or null if not font set
* @return the material icon size
*/
public Font getIconFont() {
return actualButton.getIconFont();
}
}