OptionPanelAPI.java

Go to the documentation of this file.

package com.fs.starfarer.api.campaign;
 
import java.awt.Color;
import java.util.List;
 
import com.fs.starfarer.api.impl.campaign.rulecmd.SetStoryOption.StoryOptionParams;
import com.fs.starfarer.api.ui.TooltipMakerAPI;
import com.fs.starfarer.api.ui.ValueDisplayMode;
 
 
public interface OptionPanelAPI {
    
    public static interface OptionTooltipCreator {
        void createTooltip(TooltipMakerAPI tooltip, boolean hadOtherText);
    }
    
    
    void setTooltipHighlights(Object data, String ... highlights);
    void setTooltipHighlightColors(Object data, Color ... colors);
    
    void clearOptions();
    void addOption(String text, Object data);
    void addOption(String text, Object data, String tooltip);
    void addOption(String text, Object data, Color color, String tooltip);
    
    void setShortcut(Object data, int code, boolean ctrl, boolean alt, boolean shift, boolean putLast);
    
    void setEnabled(Object data, boolean enabled);
    
    
    void setTooltip(Object data, String tooltipText);
    
    void addSelector(String text, Object data, Color color,
                     float width, float maxValueWidth, float minValue, float maxValue,
                     ValueDisplayMode mode, String tooltip);
    
    boolean hasSelector(Object data);
    
    void setSelectorValue(Object data, float value);
    
    float getSelectorValue(Object data);
    float getMinSelectorValue(Object data);
    float getMaxSelectorValue(Object data);
    boolean hasOptions();
    
    List getSavedOptionList();
    void restoreSavedOptions(List list);
    
    void addOptionConfirmation(Object optionId, String text, String yes, String no);
    boolean hasOption(Object data);
    void addOptionConfirmation(Object data, StoryPointActionDelegate confirmDelegate);
    void addOptionTooltipAppender(Object data, OptionTooltipCreator optionTooltipCreator);
    void setOptionText(String text, Object data);
    boolean hasOptionTooltipAppender(Object data);
    boolean optionHasConfirmDelegate(Object data);
    Object getOptionDataBeingConfirmed();
    void removeOption(Object data);
    
    void setStoryOptionParams(Object data, StoryOptionParams params, StoryPointActionDelegate delegate);
}