English site 日本語サイト

4.13. StarIoExtManager

プリンターと常時接続を行うことで、リアルタイムな状態取得機能を提供します。

• 列挙体

  名称	説明
  Type	マネージャタイプ定数
  PrinterStatus	プリンターステータス定数
  PrinterPaperStatus	プリンター用紙ステータス定数
  PrinterCoverStatus	プリンターカバーステータス定数
  CashDrawerStatus	キャッシュドロアーステータス定数
  BarcodeReaderStatus	バーコードリーダーステータス定数

• コンストラクタ

  名称	説明
  StarIoExtManager	StarIoExtManagerを初期化します。

• メソッド

  名称	説明
  connect	マネージメントを開始します。
  disconnect	マネージメントを停止します。
  getPort	StarIOPort オブジェクトを取得します。
  getPrinterStatus	プリンターステータスを取得します。
  getPrinterPaperStatus	プリンター用紙ステータスを取得します。
  getPrinterCoverStatus	プリンターカバーステータスを取得します。
  getCashDrawerStatus	キャッシュドロアーステータスを取得します。
  getBarcodeReaderStatus	バーコードリーダーステータスを取得します。
  getCashDrawerOpenActiveHigh	キャッシュドロアー開閉センサーのモードを取得します。
  setCashDrawerOpenActiveHigh	キャッシュドロアー開閉センサーのモードを設定します。
  setListener	StarIoExtManagerのリスナーオブジェクトを設定します。

重要

SM-Sシリーズ、SM-Tシリーズでは、自動パワーダウンモードを"NO USE"（工場出荷時設定）に設定してください。

警告

• 一台のプリンターに対して、一つのインスタンスのみ使用してください。

• 本クラスの1つのインスタンスを複数スレッドから使用する場合は、排他制御を行ってください。

4.13.1. Type

マネージャタイプ定数です。

• 宣言

  public enum Type {
      Standard,
      WithBarcodeReader,
      OnlyBarcodeReader
  }
  

• 定数

  名称	説明
  Standard	プリンター、キャッシュドロワのマネージメント
  WithBarcodeReader	プリンター、キャッシュドロワ、バーコードリーダーのマネージメント
  OnlyBarcodeReader	バーコードリーダーのマネージメント

4.13.2. PrinterStatus

プリンターステータス定数です。

• 宣言

  public enum PrinterStatus {
      Invalid,
      Impossible,
      Online,
      Offline
  }
  

• 定数

  名称	説明
  Invalid	不定
  Impossible	プリンター使用不能
  Online	プリンターオンライン検出
  Offline	プリンターオフライン検出

4.13.3. PrinterPaperStatus

プリンター用紙ステータス定数です。

• 宣言

  public enum PrinterPaperStatus {
      Invalid,
      Impossible,
      Ready,
      NearEmpty,
      Empty
  }
  

• 定数

  名称	説明
  Invalid	不定
  Impossible	プリンター使用不能
  Ready	プリンター用紙レディ検出
  NearEmpty	プリンター用紙ニアエンド検出
  Empty	プリンター用紙エンプティ検出

4.13.4. PrinterCoverStatus

プリンターカバーステータス定数です。

• 宣言

  public enum PrinterCoverStatus {
      Invalid,
      Impossible,
      Open,
      Close
  }
  

• 定数

  名称	説明
  Invalid	不定
  Impossible	プリンター使用不能
  Open	プリンターカバーオープン検出
  Close	プリンターカバークローズ検出

4.13.5. CashDrawerStatus

キャッシュドロアーステータス定数です。

• 宣言

  public enum CashDrawerStatus {
      Invalid,
      Impossible,
      Open,
      Close
  }
  

• 定数

  名称	説明
  Invalid	不定
  Impossible	キャッシュドロアー使用不能
  Open	キャッシュドロアーオープン検出
  Close	キャッシュドロアークローズ検出

4.13.6. BarcodeReaderStatus

バーコードリーダーステータス定数です。

• 宣言

  public enum BarcodeReaderStatus {
      Invalid,
      Impossible,
      Connect,
      Disconnect
  }
  

• 定数

  名称	説明
  Invalid	不定
  Impossible	バーコードリーダー使用不能
  Connect	バーコードリーダー接続検出
  Disconnect	バーコードリーダー切断検出

4.13.7. StarIoExtManager

StarIoExtManager を初期化します。

• 宣言

  StarIoExtManager(Type type, String portName, String portSetting, int ioTimeoutMillis, Context context);
  

• 引数

  名称	説明	型
  type	マネージャタイプ	Type
  portName	プリンターポート名 getPort メソッドのportNameと同じです。	String
  portSettings	ポートセッティング getPort メソッドのportSettingと同じです。	String
  ioTimeoutMillis	内部制御およびAPIのタイムアウト値	int
  context	コンテキスト	android.context.Context

• 戻り値

  説明	型
  StarIoExtManager オブジェクト	StarIoExtManager

• 実装例

  public void onCreate(Bundle savedInstanceState) {
      super.onCreate(savedInstanceState);
  
      PrinterSetting setting = new PrinterSetting(getContext());
  
      mStarIoExtManager = new StarIoExtManager(StarIoExtManager.Type.Standard, setting.getPortName(), setting.getPrinterType(), 10000, getContext()); // 10000mS!!!
  
      mStarIoExtManager.setListener(mStarIoExtManagerListener);
  }
  

  PrinterExtFragment.java / CashDrawerExtFragment.java / BarcodeReaderExtFragment.java / CombinationExtFragment.java を参照ください。

4.13.8. connect

マネージメントを開始します。

• 宣言

  public void connect(final ConnectionCallback callback);
  public void connect(final IConnectionCallback callback);
  

• 引数

  名称	説明	型	ライブラリバージョン
  callback	接続が完了した際、接続結果を onConnected メソッドの引数によって捉えることができます。 * result ... 接続結果 * resultCode ... リザルトコード	ConnectionCallback	1.10.0+
  callback	接続が完了した際、接続結果を onConnected メソッドの引数によって捉えることができます。 * result ... 接続結果	IConnectionCallback	1.3.0+

• 戻り値

  なし

• 実装例

  public void connect(final ConnectionCallback callback);

  public class PrinterExtFragment extends Fragment {
  
      ...
  
      @Override
      public void onStart() {
          super.onStart();
  
          ...
  
          mStarIoExtManager.connect(mConnectionCallback);
      }
  
      ...
  
      private final ConnectionCallback mConnectionCallback = new ConnectionCallback() {
          @Override
          public void onConnected(boolean result, int resultCode) {
          ...
          }
  
          @Override
          public void onDisconnected() {
          // do nothing
          }
      };
  }
  

  PrinterExtFragment.java / CashDrawerExtFragment.java / BarcodeReaderExtFragment.java / CombinationExtFragment.java を参照ください。

  public void connect(final IConnectionCallback callback);

  public class PrinterExtFragment extends Fragment implements IConnectionCallback {
  
      ...
  
      @Override
      public void onStart() {
          super.onStart();
  
          ...
  
          mStarIoExtManager.connect(this);
      }
  
      ...
  
      @Override
      public void onConnected() {
          Log.d("PrinterExtFragment", "onConnected " + result);
  
          ...
      }
  
      ...
  }
  

4.13.9. disconnect

マネージメントを停止します。

• 宣言

  public void disconnect(ConnectionCallback callback);
  public void disconnect(IConnectionCallback callback);
  

• 引数

  名称	説明	型	ライブラリバージョン
  callback	切断が完了した際、切断完了を onDisconnected メソッドの引数によって捉えることができます。	ConnectionCallback	1.10.0+
  callback	切断が完了した際、切断完了を onDisconnected メソッドの引数によって捉えることができます。	IConnectionCallback	1.3.0+

• 戻り値

  なし

• 実装例

  public void disconnect(ConnectionCallback callback);

  public class PrinterExtFragment extends Fragment {
  
      ...
  
      @Override
      public void onStop() {
          super.onStop();
  
          ...
  
          mStarIoExtManager.disconnect(mConnectionCallback);
      }
      ...
      private final ConnectionCallback mConnectionCallback = new ConnectionCallback() {
          @Override
          public void onConnected(boolean result, int resultCode) {
          ...
          }
  
          @Override
          public void onDisconnected() {
          // do nothing
          }
      };
  }
  

  PrinterExtFragment.java / CashDrawerExtFragment.java / BarcodeReaderExtFragment.java / CombinationExtFragment.java を参照ください。

  public void disconnect(IConnectionCallback callback);

  public class PrinterExtFragment extends Fragment implements IConnectionCallback {
  
      ...
  
      @Override
      public void onStop() {
          super.onStop();
  
          ...
  
          mStarIoExtManager.disconnect(this);
      }
  
      ...
  
      @Override
      public void onDisconnected() {
          Log.d("PrinterExtFragment", "onDisconnected");
  
          ...
      }
  
      ...
  }
  

4.13.10. getPort

StarIOPort オブジェクトを示します。

• 宣言

  StarIOPort getPort();
  

• 引数

  なし

• 戻り値

  説明	型
  StarIOPort オブジェクト	StarIOPort

4.13.11. getPrinterStatus

プリンターオンラインステータスを示します。

• 宣言

  PrinterStatus getPrinterStatus();
  

• 引数

  なし

• 戻り値

  説明	型
  プリンターステータス	getPrinterStatus

4.13.12. getPrinterPaperStatus

プリンター用紙ステータスを示します。

• 宣言

  PrinterPaperStatus getPrinterPaperStatus();
  

• 引数

  なし

• 戻り値

  説明	型
  プリンター用紙ステータス	PrinterPaperStatus

4.13.13. getPrinterCoverStatus

プリンターカバーステータスを示します。

• 宣言

  PrinterCoverStatus getPrinterCoverStatus();
  

• 引数

  なし

• 戻り値

  説明	型
  プリンターカバーステータス	PrinterCoverStatus

4.13.14. getCashDrawerStatus

キャッシュドロアーステータスを取得します。

• 宣言

  CashDrawerStatus getCashDrawerStatus();
  

• 引数

  なし

• 戻り値

  説明	型
  キャッシュドロアーステータス	CashDrawerStatus

4.13.15. getBarcodeReaderStatus

バーコードリーダーステータスを示します。

• 宣言

  BarcodeReaderStatus getBarcodeReaderStatus();
  

• 引数

  なし

• 戻り値

  説明	型
  バーコードリーダーステータス	BarcodeReaderStatus

4.13.16. getCashDrawerOpenActiveHigh

キャッシュドロアー開閉センサのモードを示します。

• 宣言

  boolean getCashDrawerOpenActiveHigh();
  

• 引数

  なし

• 戻り値

  説明	型
  キャッシュドロアー開閉センサモード true ... Highアクティブ false ... Lowアクティブ	boolean

4.13.17. setCashDrawerOpenActiveHigh

キャッシュドロアー開閉センサのモードを設定します。

• 宣言

  void setCashDrawerOpenActiveHigh(boolean isActiveHigh);
  

• 引数

  名称	説明	型
  isActiveHigh	キャッシュドロアー開閉センサモード true ... Highアクティブ false ... Lowアクティブ	boolean

  警告

  mPOPメカニズム構造においてはデフォルト値（YES）のこと

• 戻り値

  なし

4.13.18. setListener

StarIoExtManager のリスナーオブジェクトを設定します。

• 宣言

  void setListener(StarIoExtManagerListener listener);
  

• 引数

  名称	説明	型
  listener	StarIoExtManagerのリスナーオブジェクト	StarIoExtManagerListener

• 戻り値

  なし

• 実装例

  public class PrinterExtFragment extends Fragment implements IConnectionCallback {
  
      ...
  
      public void onStart() {
          super.onStart();
  
          ...
  
          mStarIoExtManager.setListener(mStarIoExtManagerListener);
  
          ...
      }
  
      private final StarIoExtManagerListener mStarIoExtManagerListener = new StarIoExtManagerListener() {
  
          ...
  
      };
  }
  

  PrinterExtFragment.java / CashDrawerExtFragment.java / BarcodeReaderExtFragment.java / CombinationExtFragment.java を参照ください。